LibreOffice
LibreOffice 6.4 SDK C/C++ API Reference
|
Go to the documentation of this file.
20 #ifndef INCLUDED_OSL_SOCKET_H
21 #define INCLUDED_OSL_SOCKET_H
31 #define OSL_INADDR_NONE 0xffffffff
32 #define OSL_INVALID_PORT (-1)
288 sal_Int32 MaxPendingConnections);
323 sal_uInt32 BytesToRead,
350 sal_uInt32 BufferSize,
372 sal_uInt32 BytesToSend,
405 sal_uInt32 BytesToSend,
529 sal_uInt32 BufferLen);
553 sal_uInt32 BufferLen);
595 rtl_uString **strError);
741 rtl_uString *strHostname);
753 rtl_uString *strDottedAddr, sal_Int32 Port);
764 rtl_uString *strDottedAddr, sal_Int32 Port);
778 rtl_uString *strServicename, rtl_uString *strProtocol);
918 #endif // INCLUDED_OSL_SOCKET_H
@ osl_Socket_OptionType
Definition: socket.h:108
@ osl_Socket_OptionAcceptConn
Definition: socket.h:84
@ osl_Socket_E_NoBufferSpace
Definition: socket.h:172
SAL_DLLPUBLIC oslSocket osl_createSocket(oslAddrFamily Family, oslSocketType Type, oslProtocol Protocol)
Create a socket of the specified Family and Type.
@ osl_Socket_E_ConnReset
Definition: socket.h:171
SAL_DLLPUBLIC sal_Int32 osl_demultiplexSocketEvents(oslSocketSet IncomingSet, oslSocketSet OutgoingSet, oslSocketSet OutOfBandSet, const TimeValue *pTimeout)
Checks multiple sockets for events.
@ osl_Socket_FORCE_EQUAL_SIZE
Definition: socket.h:197
@ osl_Socket_OptionInvalid
Definition: socket.h:111
@ osl_Socket_E_MsgSize
Definition: socket.h:155
@ osl_Socket_E_NetDown
Definition: socket.h:166
@ osl_Socket_E_OpNotSupport
Definition: socket.h:160
oslProtocol
represent a specific protocol within an address-family
Definition: socket.h:52
SAL_DLLPUBLIC oslSocketType osl_getSocketType(oslSocket Socket)
Queries the socket for its type.
@ osl_Socket_Interrupted
Definition: socket.h:195
SAL_DLLPUBLIC void osl_removeFromSocketSet(oslSocketSet Set, oslSocket Socket)
Removes a socket from the set.
SAL_DLLPUBLIC sal_Bool osl_isNonBlockingMode(oslSocket Socket)
Query state of non-blocking-mode of the socket.
@ osl_Socket_OptionUseLoopback
Definition: socket.h:90
@ osl_Socket_E_NotSocket
Definition: socket.h:153
@ osl_Socket_E_AddrInUse
Definition: socket.h:164
oslSocketDirection
Used by shutdown to denote which end of the socket to "close".
Definition: socket.h:141
SAL_DLLPUBLIC sal_Bool osl_shutdownSocket(oslSocket Socket, oslSocketDirection Direction)
Shuts down communication on a connected socket.
SAL_DLLPUBLIC sal_Int32 osl_sendToSocket(oslSocket Socket, oslSocketAddr ReceiverAddr, const void *pBuffer, sal_uInt32 BytesToSend, oslSocketMsgFlag Flag)
Tries to send one datagram with BytesToSend data to the given ReceiverAddr via the (implicitly unconn...
SAL_DLLPUBLIC sal_Bool osl_isReceiveReady(oslSocket Socket, const TimeValue *pTimeout)
Checks if read operations will block.
@ osl_Socket_DirWrite
Definition: socket.h:143
@ osl_Socket_LevelSocket
Definition: socket.h:119
SAL_DLLPUBLIC sal_Int32 osl_getServicePort(rtl_uString *strServicename, rtl_uString *strProtocol)
Looks up the port-number designated to the specified service/protocol-pair.
@ osl_Socket_MsgPeek
Definition: socket.h:131
@ osl_Socket_E_Shutdown
Definition: socket.h:175
@ osl_Socket_OptionSndLowat
Definition: socket.h:99
@ osl_Socket_LevelInvalid
Definition: socket.h:121
@ osl_Socket_OptionRcvBuf
Definition: socket.h:98
oslSocketType
Represents the type of a socket.
Definition: socket.h:64
sal_uInt8 oslSocketIpxNetNumber[4]
Definition: socket.h:200
SAL_DLLPUBLIC oslSocketResult osl_connectSocketTo(oslSocket Socket, oslSocketAddr Addr, const TimeValue *pTimeout)
Connects the socket to the given address.
SAL_DLLPUBLIC oslHostAddr osl_copyHostAddr(const oslHostAddr Addr)
Create a copy of the given Addr.
SAL_DLLPUBLIC sal_Bool osl_setInetPortOfSocketAddr(oslSocketAddr Addr, sal_Int32 Port)
Sets the Port of Addr.
@ osl_Socket_TypeRaw
Definition: socket.h:67
SAL_DLLPUBLIC sal_Bool osl_setSocketOption(oslSocket Socket, oslSocketOptionLevel Level, oslSocketOption Option, void *pBuffer, sal_uInt32 BufferLen)
Sets the sockets attributes.
unsigned char sal_uInt8
Definition: types.h:44
@ osl_Socket_E_FORCE_EQUAL_SIZE
Definition: socket.h:185
SAL_DLLPUBLIC sal_Int32 osl_writeSocket(oslSocket Socket, const void *pBuffer, sal_Int32 nSize)
Writes n bytes from pBuffer to the stream.
@ osl_Socket_OptionOOBinLine
Definition: socket.h:95
@ osl_Socket_OptionKeepAlive
Definition: socket.h:86
@ osl_Socket_E_TooManyRefs
Definition: socket.h:176
SAL_DLLPUBLIC oslSocketResult osl_getHostnameOfSocketAddr(oslSocketAddr Addr, rtl_uString **strHostname)
Returns the hostname represented by Addr.
@ osl_Socket_E_AddrNotAvail
Definition: socket.h:165
@ osl_Socket_MsgInvalid
Definition: socket.h:134
SAL_DLLPUBLIC oslHostAddr osl_createHostAddrByName(rtl_uString *strHostname)
Create an oslHostAddr by resolving the given strHostname.
@ osl_Socket_E_ConnAborted
Definition: socket.h:170
@ osl_Socket_OptionRcvTimeo
Definition: socket.h:106
@ osl_Socket_ProtocolInvalid
Definition: socket.h:57
SAL_DLLPUBLIC oslSocketAddr osl_createInetBroadcastAddr(rtl_uString *strDottedAddr, sal_Int32 Port)
Create an internet address usable for sending broadcast datagrams.
@ osl_Socket_DirInvalid
Definition: socket.h:145
SAL_DLLPUBLIC oslHostAddr osl_createHostAddrByAddr(const oslSocketAddr Addr)
Create an oslHostAddr by reverse resolution of the given Addr.
unsigned char sal_Bool
Definition: types.h:38
@ osl_Socket_E_PfNoSupport
Definition: socket.h:161
@ osl_Socket_OptionReuseAddr
Definition: socket.h:85
struct oslHostAddrImpl * oslHostAddr
Definition: socket.h:847
oslSocketMsgFlag
Represents flags to be used with send/recv-calls.
Definition: socket.h:128
SAL_DLLPUBLIC oslHostAddr osl_createHostAddr(rtl_uString *strHostname, const oslSocketAddr Addr)
Create an oslHostAddr from given hostname and socket address.
@ osl_Socket_FamilyIpx
Definition: socket.h:44
SAL_DLLPUBLIC sal_Int32 osl_getInetPortOfSocketAddr(oslSocketAddr Addr)
Retrieves the internet port-number of Addr.
@ osl_Socket_OptionTcpNoDelay
Definition: socket.h:110
@ osl_Socket_ProtocolIp
Definition: socket.h:53
SAL_DLLPUBLIC oslAddrFamily osl_getFamilyOfSocketAddr(oslSocketAddr Addr)
Retrieves the address-family from the Addr.
SAL_DLLPUBLIC sal_Bool osl_isEqualSocketAddr(oslSocketAddr Addr1, oslSocketAddr Addr2)
Compares the values of two SocketAddresses.
@ osl_Socket_FamilyInvalid
Definition: socket.h:45
@ osl_Socket_E_Prototype
Definition: socket.h:156
@ osl_Socket_InProgress
Definition: socket.h:196
@ osl_Socket_E_NetReset
Definition: socket.h:168
struct oslSocketImpl * oslSocket
Definition: socket.h:209
SAL_DLLPUBLIC void osl_destroyHostAddr(oslHostAddr Addr)
Frees all resources allocated by Addr.
@ osl_Socket_Protocol_FORCE_EQUAL_SIZE
Definition: socket.h:58
SAL_DLLPUBLIC sal_Int32 osl_receiveSocket(oslSocket Socket, void *pBuffer, sal_uInt32 BytesToRead, oslSocketMsgFlag Flag)
Tries to receive BytesToRead data from the connected socket, if no error occurs.
SAL_DLLPUBLIC oslSocketAddr osl_createInetSocketAddr(rtl_uString *strDottedAddr, sal_Int32 Port)
Create an internet-address, consisting of host address and port.
struct oslSocketAddrImpl * oslSocketAddr
Opaque datatype SocketAddr.
Definition: socket.h:37
oslSocketResult
Common return codes of socket related functions.
Definition: socket.h:190
@ osl_Socket_Msg_FORCE_EQUAL_SIZE
Definition: socket.h:135
#define SAL_DLLPUBLIC
Definition: saldllapi.h:30
@ osl_Socket_OptionError
Definition: socket.h:107
@ osl_Socket_ProtocolSpx
Definition: socket.h:55
@ osl_Socket_DirRead
Definition: socket.h:142
SAL_DLLPUBLIC void osl_addToSocketSet(oslSocketSet Set, oslSocket Socket)
Adds a socket to the set.
SAL_DLLPUBLIC sal_Bool osl_isInSocketSet(oslSocketSet Set, oslSocket Socket)
Checks if socket is in the set.
@ osl_Socket_E_ConnRefused
Definition: socket.h:178
@ osl_Socket_E_NetUnreachable
Definition: socket.h:167
oslSocketOption
Represents socket-options.
Definition: socket.h:82
SAL_DLLPUBLIC oslSocketResult osl_getAddrOfSocketAddr(oslSocketAddr Addr, sal_Sequence **ppByteSeq)
Returns the addr field in the struct sockaddr.
SAL_DLLPUBLIC void osl_getHostnameOfHostAddr(const oslHostAddr Addr, rtl_uString **strHostname)
Get the hostname member of Addr.
oslSocketError
Describes the various error socket error conditions, which may occur.
Definition: socket.h:151
@ osl_Socket_MsgNormal
Definition: socket.h:129
@ osl_Socket_E_TypeNoSupport
Definition: socket.h:159
@ osl_Socket_Type_FORCE_EQUAL_SIZE
Definition: socket.h:75
SAL_DLLPUBLIC sal_Bool osl_bindAddrToSocket(oslSocket Socket, oslSocketAddr Addr)
Binds the given address to the socket.
@ osl_Socket_TimedOut
Definition: socket.h:194
SAL_DLLPUBLIC oslSocketResult osl_getLocalHostname(rtl_uString **strLocalHostname)
Retrieve this machines hostname.
@ osl_Socket_E_NotConnected
Definition: socket.h:174
@ osl_Socket_OptionLinger
Definition: socket.h:92
SAL_DLLPUBLIC oslSocketAddr osl_getSocketAddrOfHostAddr(const oslHostAddr Addr)
Get the socket address member of Addr.
@ osl_Socket_OptionDontRoute
Definition: socket.h:87
SAL_DLLPUBLIC void osl_closeSocket(oslSocket Socket)
Closes the socket terminating any ongoing dataflow.
@ osl_Socket_E_ProtocolNoSupport
Definition: socket.h:158
@ osl_Socket_E_WouldBlock
Definition: socket.h:181
@ osl_Socket_E_HostDown
Definition: socket.h:179
@ osl_Socket_E_InvalidError
Definition: socket.h:184
@ osl_Socket_E_NoProtocol
Definition: socket.h:157
@ osl_Socket_MsgOOB
Definition: socket.h:130
SAL_DLLPUBLIC sal_Int32 osl_sendSocket(oslSocket Socket, const void *pBuffer, sal_uInt32 BytesToSend, oslSocketMsgFlag Flag)
Tries to send BytesToSend data from the connected socket, if no error occurs.
@ osl_Socket_E_Already
Definition: socket.h:182
@ osl_Socket_E_TimedOut
Definition: socket.h:177
@ osl_Socket_Level_FORCE_EQUAL_SIZE
Definition: socket.h:122
@ osl_Socket_Option_FORCE_EQUAL_SIZE
Definition: socket.h:112
@ osl_Socket_ProtocolSpxII
Definition: socket.h:56
@ osl_Socket_MsgDontRoute
Definition: socket.h:132
SAL_DLLPUBLIC void osl_clearSocketSet(oslSocketSet Set)
Clears the set from all previously added sockets.
@ osl_Socket_TypeSeqPacket
Definition: socket.h:71
SAL_DLLPUBLIC oslSocketAddr osl_createEmptySocketAddr(oslAddrFamily Family)
Creates a socket-address for the given family.
SAL_DLLPUBLIC sal_Int32 osl_receiveFromSocket(oslSocket Socket, oslSocketAddr SenderAddr, void *pBuffer, sal_uInt32 BufferSize, oslSocketMsgFlag Flag)
Tries to receives BufferSize data from the (usually unconnected) (datagram-)socket,...
SAL_DLLPUBLIC void osl_destroySocketSet(oslSocketSet Set)
Destroys an oslSocketSet.
@ osl_Socket_OptionSndBuf
Definition: socket.h:97
@ osl_Socket_OptionDebug
Definition: socket.h:83
#define SAL_MAX_ENUM
Definition: types.h:223
This is the binary specification of a SAL sequence.
Definition: types.h:322
@ osl_Socket_MsgMaxIOVLen
Definition: socket.h:133
SAL_DLLPUBLIC sal_Int32 osl_getSocketOption(oslSocket Socket, oslSocketOptionLevel Level, oslSocketOption Option, void *pBuffer, sal_uInt32 BufferLen)
Retrieves attributes associated with the socket.
SAL_DLLPUBLIC oslSocketSet osl_createSocketSet(void)
Creates a set of sockets to be used with osl_demultiplexSocketEvents().
SAL_DLLPUBLIC oslSocketAddr osl_getLocalAddrOfSocket(oslSocket Socket)
Retrieves the Address of the local end of the socket.
SAL_DLLPUBLIC oslSocketResult osl_getDottedInetAddrOfSocketAddr(oslSocketAddr Addr, rtl_uString **strDottedInetAddr)
Gets the address in dotted decimal format.
@ osl_Socket_E_InProgress
Definition: socket.h:183
@ osl_Socket_TypeInvalid
Definition: socket.h:74
@ osl_Socket_ProtocolIpx
Definition: socket.h:54
SAL_DLLPUBLIC sal_Bool osl_isExceptionPending(oslSocket Socket, const TimeValue *pTimeout)
Checks if a request for out-of-band data will block.
@ osl_Socket_Ok
Definition: socket.h:191
@ osl_Socket_FamilyInet
Definition: socket.h:43
@ osl_Socket_TypeStream
Definition: socket.h:65
SAL_DLLPUBLIC oslSocket osl_acceptConnectionOnSocket(oslSocket Socket, oslSocketAddr *pAddr)
Waits for an ingoing connection on the socket.
@ osl_Socket_E_HostUnreachable
Definition: socket.h:180
SAL_DLLPUBLIC void osl_acquireSocket(oslSocket Socket)
increases the refcount of the socket handle by one
SAL_DLLPUBLIC void osl_destroySocketAddr(oslSocketAddr Addr)
Frees all resources allocated by Addr.
@ osl_Socket_Family_FORCE_EQUAL_SIZE
Definition: socket.h:46
struct oslSocketSetImpl * oslSocketSet
Type for the representation of socket sets.
Definition: socket.h:608
SAL_DLLPUBLIC sal_Bool osl_listenOnSocket(oslSocket Socket, sal_Int32 MaxPendingConnections)
Prepares the socket to act as an acceptor of incoming connections.
SAL_DLLPUBLIC sal_Int32 osl_readSocket(oslSocket Socket, void *pBuffer, sal_Int32 nSize)
Retrieves n bytes from the stream and copies them into pBuffer.
SAL_DLLPUBLIC sal_Bool osl_isSendReady(oslSocket Socket, const TimeValue *pTimeout)
Checks if send operations will block.
SAL_DLLPUBLIC oslSocketError osl_getLastSocketError(oslSocket Socket)
Returns a constant describing the last error for the socket system.
@ osl_Socket_OptionBroadcast
Definition: socket.h:89
SAL_DLLPUBLIC oslSocketAddr osl_getPeerAddrOfSocket(oslSocket Socket)
Retrieves the Address of the remote end of the socket.
sal_uInt8 oslSocketIpxNodeNumber[6]
Definition: socket.h:201
SAL_DLLPUBLIC oslSocketResult osl_setAddrOfSocketAddr(oslSocketAddr Addr, sal_Sequence *pByteSeq)
Sets the addr field in the struct sockaddr with pByteSeq.
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
@ osl_Socket_E_None
Definition: socket.h:152
@ osl_Socket_E_DestAddrReq
Definition: socket.h:154
@ osl_Socket_Error
Definition: socket.h:192
@ osl_Socket_LevelTcp
Definition: socket.h:120
SAL_DLLPUBLIC void osl_getLastSocketErrorDescription(oslSocket Socket, rtl_uString **strError)
returns a string which describes the last socket error.
@ osl_Socket_E_IsConnected
Definition: socket.h:173
@ osl_Socket_E_AfNoSupport
Definition: socket.h:162
@ osl_Socket_OptionSndTimeo
Definition: socket.h:105
@ osl_Socket_Dir_FORCE_EQUAL_SIZE
Definition: socket.h:146
SAL_DLLPUBLIC oslSocketAddr osl_copySocketAddr(oslSocketAddr Addr)
Creates a new SocketAddress and fills it from Addr.
@ osl_Socket_TypeRdm
Definition: socket.h:68
@ osl_Socket_OptionRcvLowat
Definition: socket.h:102
SAL_DLLPUBLIC oslSocketAddr osl_resolveHostname(rtl_uString *strHostname)
Uses the systems name-service interface to find an address for strHostname.
SAL_DLLPUBLIC sal_Bool osl_enableNonBlockingMode(oslSocket Socket, sal_Bool On)
Enables/disables non-blocking-mode of the socket.
@ osl_Socket_DirReadWrite
Definition: socket.h:144
SAL_DLLPUBLIC void osl_releaseSocket(oslSocket Socket)
decreases the refcount of the socket handle by one.