LibreOffice
LibreOffice 6.4 SDK C/C++ API Reference
|
Go to the documentation of this file.
20 #ifndef INCLUDED_OSL_SOCKET_DECL_HXX
21 #define INCLUDED_OSL_SOCKET_DECL_HXX
53 #if defined LIBO_INTERNAL_ONLY
77 inline SocketAddr(const ::rtl::OUString& strAddrOrHostName, sal_Int32 nPort);
88 inline bool is()
const;
109 inline bool SAL_CALL
setHostname(const ::rtl::OUString &sDottedIpOrHostname);
115 inline sal_Int32 SAL_CALL
getPort()
const;
124 inline bool SAL_CALL
setPort(sal_Int32 nPort);
131 inline bool SAL_CALL
setAddr(const ::rtl::ByteSequence & address);
143 #if defined LIBO_INTERNAL_ONLY
177 const ::rtl::OUString & strHostName ,
SocketAddr & Addr );
186 const ::rtl::OUString& strServiceName,
187 const ::rtl::OUString & strProtocolName= ::
rtl::OUString(
"tcp") );
256 inline void SAL_CALL
close();
287 inline ::rtl::OUString SAL_CALL
getPeerHost()
const;
430 sal_uInt32 BufferLen,
476 sal_uInt32 BufferLen,
554 inline sal_Int32 SAL_CALL
read(
void* pBuffer, sal_uInt32 n);
563 inline sal_Int32 SAL_CALL
write(
const void* pBuffer, sal_uInt32 n);
582 inline sal_Int32 SAL_CALL
recv(
void* pBuffer,
583 sal_uInt32 BytesToRead,
602 sal_Int32 SAL_CALL
send(
const void* pBuffer,
603 sal_uInt32 BytesToSend,
651 inline bool SAL_CALL
listen(sal_Int32 MaxPendingConnections= -1);
709 inline sal_Int32 SAL_CALL
recvFrom(
void* pBuffer,
710 sal_uInt32 BufferSize,
738 sal_uInt32 BufferSize,
bool isSendReady(const TimeValue *pTimeout=NULL) const
Checks if send operations will block.
Definition: socket.hxx:329
bool setPort(sal_Int32 nPort)
Sets the port number of the address.
Definition: socket.hxx:99
inline ::rtl::OUString getLocalHost() const
Get the hostname for the local interface.
Definition: socket.hxx:287
DatagramSocket(oslAddrFamily Family=osl_Socket_FamilyInet, oslProtocol Protocol=osl_Socket_ProtocolIp, oslSocketType Type=osl_Socket_TypeDgram)
Creates a datagram socket.
Definition: socket.hxx:528
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:448
~SocketAddr()
destroys underlying oslSocketAddress
Definition: socket.hxx:76
oslProtocol
represent a specific protocol within an address-family
Definition: socket.h:52
Definition: socket_decl.hxx:608
SocketAddr()
Creates socket address of unknown type.
Definition: socket.hxx:27
inline ::rtl::OUString getPeerHost() const
Get the hostname for the remote interface.
Definition: socket.hxx:309
The class should be understood as a reference to a socket address handle (struct sockaddr).
Definition: socket_decl.hxx:40
This String class provides base functionality for C++ like Unicode character array handling.
Definition: ustring.hxx:127
Definition: condition.hxx:28
oslSocketType getType() const
Queries the socket for its type.
Definition: socket.hxx:341
bool is() const
Checks if the SocketAddr was created successful.
Definition: socket.hxx:174
bool operator==(const Socket &rSocket) const
Definition: socket.hxx:249
bool isExceptionPending(const TimeValue *pTimeout=NULL) const
Checks if a request for out-of-band data will block.
Definition: socket.hxx:335
oslSocketDirection
Used by shutdown to denote which end of the socket to "close".
Definition: socket.h:141
sal_Int32 recvFrom(void *pBuffer, sal_uInt32 BufferSize, SocketAddr *pSenderAddr=NULL, oslSocketMsgFlag Flag=osl_Socket_MsgNormal)
Tries to receives BufferSize data from the socket, if no error occurs.
Definition: socket.hxx:535
sal_Int32 read(void *pBuffer, sal_uInt32 n)
Retrieves n bytes from the stream and copies them into pBuffer.
Definition: socket.hxx:436
inline ::rtl::OUString getErrorAsString() const
Builds a string with the last error-message for the socket.
Definition: socket.hxx:405
@ osl_Socket_LevelSocket
Definition: socket.h:119
SocketAddr & assign(oslSocketAddr Addr, __osl_socket_NoCopy nocopy)
Assigns the socket addr without copyconstructing it.
Definition: socket.hxx:154
oslSocket m_handle
Definition: socket_decl.hxx:194
StreamSocket(oslAddrFamily Family=osl_Socket_FamilyInet, oslProtocol Protocol=osl_Socket_ProtocolIp, oslSocketType Type=osl_Socket_TypeStream)
Creates a socket.
Definition: socket.hxx:419
AcceptorSocket(oslAddrFamily Family=osl_Socket_FamilyInet, oslProtocol Protocol=osl_Socket_ProtocolIp, oslSocketType Type=osl_Socket_TypeStream)
Definition: socket.hxx:478
bool setAddr(const ::rtl::ByteSequence &address)
Sets the address of the underlying socket address struct in network byte order.
Definition: socket.hxx:111
@ SAL_NO_COPY
Definition: socket_decl.hxx:33
oslSocketType
Represents the type of a socket.
Definition: socket.h:64
sal_Int32 getLocalPort() const
Get the local port of the socket.
Definition: socket.hxx:279
bool setHostname(const ::rtl::OUString &sDottedIpOrHostname)
Sets the IP address or hostname of the SocketAddress.
Definition: socket.hxx:104
oslSocketResult acceptConnection(StreamSocket &Connection)
Accepts incoming connections on the socket.
Definition: socket.hxx:491
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:194
inline ::rtl::OUString getHostname(oslSocketResult *pResult=NULL) const
Converts the address to a (human readable) domain-name.
Definition: socket.hxx:83
bool isNonBlockingMode() const
Query blocking mode of the socket.
Definition: socket.hxx:386
void close()
Closes a socket.
Definition: socket.hxx:267
static void resolveHostname(const ::rtl::OUString &strHostName, SocketAddr &Addr)
Tries to find an address for a host.
Definition: socket.hxx:188
oslSocketError getError() const
returns a constant describing the last error for the socket system.
Definition: socket.hxx:399
oslSocketMsgFlag
Represents flags to be used with send/recv-calls.
Definition: socket.h:128
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:347
SocketAddr & operator=(oslSocketAddr Addr)
assign the handle to this reference.
Definition: socket.hxx:127
@ osl_Socket_ProtocolIp
Definition: socket.h:53
sal_Int32 getPort() const
Returns the port number of the address.
Definition: socket.hxx:93
oslSocketAddr m_handle
Definition: socket_decl.hxx:42
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:555
struct oslSocketImpl * oslSocket
Definition: socket.h:209
bool listen(sal_Int32 MaxPendingConnections=-1)
Prepare a socket for the accept-call.
Definition: socket.hxx:485
struct oslSocketAddrImpl * oslSocketAddr
Opaque datatype SocketAddr.
Definition: socket.h:37
oslSocketResult
Common return codes of socket related functions.
Definition: socket.h:190
sal_Int32 getPeerPort() const
Get the remote port of the socket.
Definition: socket.hxx:301
bool enableNonBlockingMode(bool bNonBlockingMode)
Enables/disables non-blocking mode of the socket.
Definition: socket.hxx:380
bool operator==(oslSocketAddr Addr) const
Returns true if the underlying handle is identical to the Addr handle.
Definition: socket.hxx:163
Allows to accept socket connections.
Definition: socket_decl.hxx:638
__sal_NoAcquire
Definition: types.h:371
__osl_socket_NoCopy
Definition: socket_decl.hxx:33
oslSocketOption
Represents socket-options.
Definition: socket.h:82
oslSocketError
Describes the various error socket error conditions, which may occur.
Definition: socket.h:151
@ osl_Socket_MsgNormal
Definition: socket.h:129
void getLocalAddr(SocketAddr &Addr) const
Retrieves the address of the local interface of this socket.
Definition: socket.hxx:273
Definition: socket_decl.hxx:527
oslSocket getHandle() const
Returns the underlying handle unacquired (The caller must acquire it to keep it).
Definition: socket.hxx:413
inline ::rtl::ByteSequence getAddr(oslSocketResult *pResult=NULL) const
Returns the address of the underlying socket in network byte order.
Definition: socket.hxx:117
Socket & operator=(oslSocket socketHandle)
Assignment operator.
Definition: socket.hxx:234
void getPeerAddr(SocketAddr &Addr) const
Retrieves the address of the remote host of this socket.
Definition: socket.hxx:295
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:456
void shutdown(oslSocketDirection Direction=osl_Socket_DirReadWrite)
Closes a definite or both directions of the bidirectional stream.
Definition: socket.hxx:261
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:464
bool isRecvReady(const TimeValue *pTimeout=NULL) const
Checks if read operations will block.
Definition: socket.hxx:323
bool bind(const SocketAddr &LocalInterface)
Binds the socket to the specified (local) interface.
Definition: socket.hxx:317
~Socket()
Destructor.
Definition: socket.hxx:228
void clearError() const
clears the error status
Definition: socket.hxx:392
@ osl_Socket_FamilyInet
Definition: socket.h:43
@ osl_Socket_TypeStream
Definition: socket.h:65
bool setOption(oslSocketOption Option, void *pBuffer, sal_uInt32 BufferLen, oslSocketOptionLevel Level=osl_Socket_LevelSocket) const
Sets the sockets attributes.
Definition: socket.hxx:357
sal_Int32 write(const void *pBuffer, sal_uInt32 n)
Writes n bytes from pBuffer to the stream.
Definition: socket.hxx:442
oslSocketAddr getHandle() const
Returns the underlying SocketAddr handle without copyconstructing it.
Definition: socket.hxx:168
oslAddrFamily
Represents the address-family of a socket.
Definition: socket.h:42
oslSocketOptionLevel
Represents the different socket-option levels.
Definition: socket.h:118
@ osl_Socket_TypeDgram
Definition: socket.h:66
Definition: socket_decl.hxx:192
oslSocketResult connect(const SocketAddr &TargetHost, const TimeValue *pTimeout=NULL)
Connects the socket to a (remote) host.
Definition: socket.hxx:471
A connectionless socket to send and receive datagrams.
Definition: socket_decl.hxx:678
static inline ::rtl::OUString getLocalHostname(oslSocketResult *pResult=NULL)
Get the hostname for the local interface.
Definition: socket.hxx:179
@ osl_Socket_DirReadWrite
Definition: socket.h:144