Overview | Namespace | Class | Index | Help |
PUBLIC MEMBERS: | CLASSES | STRUCTS | UNIONS | ENUMS | TYPEDEFS | METHODS | STATIC METHODS | DATA | STATIC DATA |
PROTECTED MEMBERS: | CLASSES | STRUCTS | UNIONS | ENUMS | TYPEDEFS | METHODS | STATIC METHODS | DATA | STATIC DATA |
virtual | abstract | interface | template |
NO | NO | NO | NO |
Methods |
|
Socket( ); |
|
Socket( const Socket & socket ); |
|
Socket( oslSocket socketHandle ); |
|
Socket( oslSocket socketHandle, __sal_NoAcquire noacquire ); |
The instance takes over the handle's ownership without acquiring the handle, but releases it within the dtor. |
~Socket( ); |
Destructor. Releases the underlying handle |
Socket & operator=( oslSocket socketHandle ); |
Assignment operator. If socket was already created, the old one will be discarded. |
Socket & operator=( const Socket & sock ); |
Assignment operator. If socket was already created, the old one will be discarded. |
sal_Bool operator==( const Socket & rSocket ) const; |
|
sal_Bool operator==( const oslSocket socketHandle ) const; |
|
void shutdown( oslSocketDirection Direction = osl_Socket_DirReadWrite ); |
Closes a definite or both directions of the bidirectional stream. |
void close( ); |
|
void getLocalAddr( SocketAddr & Addr ) const; |
Retrieves the address of the local interface of this socket. |
sal_Int32 getLocalPort( ) const; |
Get the local port of the socket. Usually used after bind(). |
::rtl::OUString getLocalHost( ) const; |
Get the hostname for the local interface. |
void getPeerAddr( SocketAddr & Addr ) const; |
Retrieves the address of the remote host of this socket. |
sal_Int32 getPeerPort( ) const; |
Get the remote port of the socket. |
::rtl::OUString getPeerHost( ) const; |
Get the hostname for the remote interface. |
sal_Bool bind( const SocketAddr & LocalInterface ); |
Binds the socket to the specified (local) interface. |
sal_Bool isRecvReady( const TimeValue * pTimeout = 0 ) const; |
Checks if read operations will block. |
sal_Bool isSendReady( const TimeValue * pTimeout = 0 ) const; |
Checks if send operations will block. |
sal_Bool isExceptionPending( const TimeValue * pTimeout = 0 ) const; |
Checks if a request for out-of-band data will block. |
oslSocketType getType( ) const; |
Queries the socket for its type. |
sal_Int32 getOption( oslSocketOption Option, void * pBuffer, sal_uInt32 BufferLen, oslSocketOptionLevel Level = osl_Socket_LevelSocket ) const; |
Retrieves option-attributes associated with the socket. |
sal_Bool setOption( oslSocketOption Option, void * pBuffer, sal_uInt32 BufferLen, oslSocketOptionLevel Level = osl_Socket_LevelSocket ) const; |
Sets the sockets attributes. |
sal_Bool setOption( oslSocketOption option, sal_Int32 nValue ); |
Convenience function for setting sal_Bool and sal_Int32 option values. |
sal_Int32 getOption( oslSocketOption option ) const; |
Convenience function for retrieving sal_Bool and sal_Int32 option values. |
sal_Bool enableNonBlockingMode( sal_Bool bNonBlockingMode ); |
Enables/disables non-blocking mode of the socket. |
sal_Bool isNonBlockingMode( ) const; |
Query blocking mode of the socket. |
void clearError( ) const; |
clears the error status |
oslSocketError getError( ) const; |
returns a constant decribing the last error for the socket system. |
::rtl::OUString getErrorAsString( ) const; |
Builds a string with the last error-message for the socket. |
oslSocket getHandle( ) const; |
Returns the underlying handle unacquired (The caller must acquire it to keep it). |
Methods |
|
Socket( oslSocketType Type, oslAddrFamily Family = osl_Socket_FamilyInet, oslProtocol Protocol = osl_Socket_ProtocolIp ); |
Creates a socket. Note it's protected. |
Data |
|
oslSocket m_handle; |
Copyright © 2000, 2015 LibreOffice contributors and/or their affiliates. All rights reserved.
LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.
The Document Foundation acknowledges all community members, please find more info at our website.
Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.