20 #ifndef INCLUDED_OSL_SOCKET_DECL_HXX
21 #define INCLUDED_OSL_SOCKET_DECL_HXX
65 inline SocketAddr( const ::rtl::OUString& strAddrOrHostName, sal_Int32 nPort );
94 inline sal_Int32 SAL_CALL
getPort()
const;
104 inline sal_Bool SAL_CALL
setAddr( const ::rtl::ByteSequence & address );
148 const ::rtl::OUString & strHostName ,
SocketAddr & Addr );
157 const ::rtl::OUString& strServiceName,
158 const ::rtl::OUString & strProtocolName= ::
rtl::OUString(
"tcp") );
227 inline void SAL_CALL
close();
258 inline ::rtl::OUString SAL_CALL
getPeerHost()
const;
403 sal_uInt32 BufferLen,
449 sal_uInt32 BufferLen,
529 inline sal_Int32 SAL_CALL
read(
void* pBuffer, sal_uInt32 n);
538 inline sal_Int32 SAL_CALL
write(
const void* pBuffer, sal_uInt32 n);
557 inline sal_Int32 SAL_CALL
recv(
void* pBuffer,
558 sal_uInt32 BytesToRead,
577 sal_Int32 SAL_CALL
send(
const void* pBuffer,
578 sal_uInt32 BytesToSend,
626 inline sal_Bool SAL_CALL
listen(sal_Int32 MaxPendingConnections= -1);
685 inline sal_Int32 SAL_CALL
recvFrom(
void* pBuffer,
686 sal_uInt32 BufferSize,
714 sal_uInt32 BufferSize,
oslSocketDirection
Used by shutdown to denote which end of the socket to "close".
Definition: socket.h:134
sal_Int32 write(const void *pBuffer, sal_uInt32 n)
Writes n bytes from pBuffer to the stream.
Definition: socket.hxx:434
SocketAddr()
Creates socket address of unknown type.
Definition: socket.hxx:27
Definition: socket_decl.hxx:582
oslSocketType getType() const
Queries the socket for its type.
Definition: socket.hxx:328
oslSocketMsgFlag
Represents flags to be used with send/recv-calls.
Definition: socket.h:121
This String class provides base functionality for C++ like Unicode character array handling...
Definition: ustring.hxx:82
sal_Bool is() const
checks, if the SocketAddr was created successful.
Definition: socket.hxx:158
sal_Bool isSendReady(const TimeValue *pTimeout=0) const
Checks if send operations will block.
Definition: socket.hxx:316
~SocketAddr()
destroys underlying oslSocketAddress
Definition: socket.hxx:71
Definition: socket_decl.hxx:162
SocketAddr & assign(oslSocketAddr Addr, __osl_socket_NoCopy nocopy)
Assigns the socket addr without copyconstructing it.
Definition: socket.hxx:138
struct oslSocketAddrImpl * oslSocketAddr
Opaque datatype SocketAddr.
Definition: socket.h:41
ConnectorSocket(oslAddrFamily Family=osl_Socket_FamilyInet, oslProtocol Protocol=osl_Socket_ProtocolIp, oslSocketType Type=osl_Socket_TypeStream)
Creates a socket that can connect to a (remote) host.
Definition: socket.hxx:457
oslSocket m_handle
Definition: socket_decl.hxx:165
void close()
Closes a socket.
Definition: socket.hxx:254
sal_Int32 recv(void *pBuffer, sal_uInt32 BytesToRead, oslSocketMsgFlag flags=osl_Socket_MsgNormal)
Tries to receive BytesToRead data from the connected socket,.
Definition: socket.hxx:441
oslSocketOption
Represents socket-options.
Definition: socket.h:84
static inline::rtl::OUString getLocalHostname(oslSocketResult *pResult=0)
Get the hostname for the local interface.
Definition: socket.hxx:164
sal_Bool setOption(oslSocketOption Option, void *pBuffer, sal_uInt32 BufferLen, oslSocketOptionLevel Level=osl_Socket_LevelSocket) const
Sets the sockets attributes.
Definition: socket.hxx:344
SocketAddr & operator=(oslSocketAddr Addr)
assign the handle to this reference.
Definition: socket.hxx:122
Socket & operator=(oslSocket socketHandle)
Assignment operator.
Definition: socket.hxx:221
oslSocketType
Represents the type of a socket.
Definition: socket.h:70
void getLocalAddr(SocketAddr &Addr) const
Retrieves the address of the local interface of this socket.
Definition: socket.hxx:260
sal_Bool enableNonBlockingMode(sal_Bool bNonBlockingMode)
Enables/disables non-blocking mode of the socket.
Definition: socket.hxx:367
inline::rtl::OUString getErrorAsString() const
Builds a string with the last error-message for the socket.
Definition: socket.hxx:392
sal_Int32 send(const void *pBuffer, sal_uInt32 BytesToSend, oslSocketMsgFlag=osl_Socket_MsgNormal)
Tries to send BytesToSend data to the connected socket.
Definition: socket.hxx:449
A connectionless socket to send and receive datagrams.
Definition: socket_decl.hxx:653
struct oslSocketImpl * oslSocket
Definition: socket.h:403
sal_Int32 sendTo(const SocketAddr &ReceiverAddr, const void *pBuffer, sal_uInt32 BufferSize, oslSocketMsgFlag Flag=osl_Socket_MsgNormal)
Tries to send one datagram with BytesToSend size to the given ReceiverAddr.
Definition: socket.hxx:549
AcceptorSocket(oslAddrFamily Family=osl_Socket_FamilyInet, oslProtocol Protocol=osl_Socket_ProtocolIp, oslSocketType Type=osl_Socket_TypeStream)
Definition: socket.hxx:471
sal_Int32 getPort() const
Returns the port number of the address.
Definition: socket.hxx:88
sal_Bool listen(sal_Int32 MaxPendingConnections=-1)
Prepare a socket for the accept-call.
Definition: socket.hxx:478
DatagramSocket(oslAddrFamily Family=osl_Socket_FamilyInet, oslProtocol Protocol=osl_Socket_ProtocolIp, oslSocketType Type=osl_Socket_TypeDgram)
Creates a datagram socket.
Definition: socket.hxx:520
Definition: socket_decl.hxx:499
oslSocketAddr m_handle
Definition: socket_decl.hxx:38
sal_Int32 getLocalPort() const
Get the local port of the socket.
Definition: socket.hxx:266
sal_Int32 recvFrom(void *pBuffer, sal_uInt32 BufferSize, SocketAddr *pSenderAddr=0, oslSocketMsgFlag Flag=osl_Socket_MsgNormal)
Tries to receives BufferSize data from the socket, if no error occurs.
Definition: socket.hxx:527
oslSocketError
Describes the various error socket error conditions, which may occur.
Definition: socket.h:144
sal_Bool isExceptionPending(const TimeValue *pTimeout=0) const
Checks if a request for out-of-band data will block.
Definition: socket.hxx:322
sal_Int32 read(void *pBuffer, sal_uInt32 n)
Retrieves n bytes from the stream and copies them into pBuffer.
Definition: socket.hxx:428
oslProtocol
represent a specific protocol within a address-family
Definition: socket.h:57
StreamSocket(oslAddrFamily Family=osl_Socket_FamilyInet, oslProtocol Protocol=osl_Socket_ProtocolIp, oslSocketType Type=osl_Socket_TypeStream)
Creates a socket.
Definition: socket.hxx:406
sal_Bool bind(const SocketAddr &LocalInterface)
Binds the socket to the specified (local) interface.
Definition: socket.hxx:304
static void resolveHostname(const ::rtl::OUString &strHostName, SocketAddr &Addr)
Tries to find an address for a host.
Definition: socket.hxx:174
oslSocketResult connect(const SocketAddr &TargetHost, const TimeValue *pTimeout=0)
Connects the socket to a (remote) host.
Definition: socket.hxx:464
oslSocket getHandle() const
Returns the underlying handle unacquired (The caller must acquire it to keep it). ...
Definition: socket.hxx:400
sal_Bool operator==(const Socket &rSocket) const
Definition: socket.hxx:236
oslSocketResult
Common return codes of socket related functions.
Definition: socket.h:183
~Socket()
Destructor.
Definition: socket.hxx:215
sal_Bool setHostname(const ::rtl::OUString &sDottedIpOrHostname)
Sets the ipaddress or hostname of the SocketAddress.
Definition: socket.hxx:99
oslSocketAddr getHandle() const
Returns the underlying SocketAddr handle without copyconstructing it.
Definition: socket.hxx:152
sal_Bool setPort(sal_Int32 nPort)
Sets the port number of the address.
Definition: socket.hxx:94
sal_Bool operator==(oslSocketAddr Addr) const
Returns true if the underlying handle is identical to the Addr handle.
Definition: socket.hxx:147
unsigned char sal_Bool
Definition: types.h:46
sal_Bool setAddr(const ::rtl::ByteSequence &address)
Sets the address of the underlying socket address struct in network byte order.
Definition: socket.hxx:106
__sal_NoAcquire
Definition: types.h:372
oslAddrFamily
Represents the address-family of a socket.
Definition: socket.h:47
oslSocketOptionLevel
Represents the different socket-option levels.
Definition: socket.h:110
inline::rtl::OUString getPeerHost() const
Get the hostname for the remote interface.
Definition: socket.hxx:296
void getPeerAddr(SocketAddr &Addr) const
Retrieves the address of the remote host of this socket.
Definition: socket.hxx:282
inline::rtl::ByteSequence getAddr(oslSocketResult *pResult=0) const
Returns the address of the underlying socket in network byte order.
Definition: socket.hxx:112
The class should be understood as a reference to a socket address handle ( struct sockaddr )...
Definition: socket_decl.hxx:35
sal_Bool isNonBlockingMode() const
Query blocking mode of the socket.
Definition: socket.hxx:373
void clearError() const
clears the error status
Definition: socket.hxx:379
void shutdown(oslSocketDirection Direction=osl_Socket_DirReadWrite)
Closes a definite or both directions of the bidirectional stream.
Definition: socket.hxx:248
sal_Int32 getPeerPort() const
Get the remote port of the socket.
Definition: socket.hxx:288
inline::rtl::OUString getLocalHost() const
Get the hostname for the local interface.
Definition: socket.hxx:274
sal_Int32 getOption(oslSocketOption Option, void *pBuffer, sal_uInt32 BufferLen, oslSocketOptionLevel Level=osl_Socket_LevelSocket) const
Retrieves option-attributes associated with the socket.
Definition: socket.hxx:334
sal_Bool isRecvReady(const TimeValue *pTimeout=0) const
Checks if read operations will block.
Definition: socket.hxx:310
inline::rtl::OUString getHostname(oslSocketResult *pResult=0) const
Converts the address to a (human readable) domain-name.
Definition: socket.hxx:78
static sal_Int32 getServicePort(const ::rtl::OUString &strServiceName, const ::rtl::OUString &strProtocolName=::rtl::OUString("tcp"))
Tries to find the port associated with the given service/protocol- pair (e.g.
Definition: socket.hxx:181
Definition: socket_decl.hxx:29
oslSocketResult acceptConnection(StreamSocket &Connection)
Accepts incoming connections on the socket.
Definition: socket.hxx:484
oslSocketError getError() const
returns a constant decribing the last error for the socket system.
Definition: socket.hxx:386
Allows to accept socket connections.
Definition: socket_decl.hxx:612
__osl_socket_NoCopy
Definition: socket_decl.hxx:29