LibreOffice
LibreOffice 6.4 SDK C/C++ API Reference
socket.h
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3  * This file is part of the LibreOffice project.
4  *
5  * This Source Code Form is subject to the terms of the Mozilla Public
6  * License, v. 2.0. If a copy of the MPL was not distributed with this
7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8  *
9  * This file incorporates work covered by the following license notice:
10  *
11  * Licensed to the Apache Software Foundation (ASF) under one or more
12  * contributor license agreements. See the NOTICE file distributed
13  * with this work for additional information regarding copyright
14  * ownership. The ASF licenses this file to you under the Apache
15  * License, Version 2.0 (the "License"); you may not use this file
16  * except in compliance with the License. You may obtain a copy of
17  * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18  */
19 
20 #ifndef INCLUDED_OSL_SOCKET_H
21 #define INCLUDED_OSL_SOCKET_H
22 
23 #include "rtl/ustring.h"
24 #include "osl/time.h"
25 
26 #ifdef __cplusplus
27 extern "C" {
28 #endif
29 
30 /* error returns */
31 #define OSL_INADDR_NONE 0xffffffff
32 #define OSL_INVALID_PORT (-1)
33 
37 typedef struct oslSocketAddrImpl * oslSocketAddr;
38 
42 typedef enum {
48 
52 typedef enum {
60 
64 typedef enum {
77 
78 
82 typedef enum {
114 
118 typedef enum {
124 
128 typedef enum {
137 
141 typedef enum {
148 
151 typedef enum {
187 
190 typedef enum {
199 
202 
209 typedef struct oslSocketImpl * oslSocket;
210 
218  oslAddrFamily Family,
219  oslSocketType Type,
220  oslProtocol Protocol);
221 
225 
232 
241 
249 
258  oslSocket Socket,
259  oslSocketAddr Addr);
260 
273  oslSocket Socket,
274  oslSocketAddr Addr,
275  const TimeValue* pTimeout);
276 
277 
287  oslSocket Socket,
288  sal_Int32 MaxPendingConnections);
289 
290 
299  oslSocket Socket,
300  oslSocketAddr* pAddr);
301 
320 SAL_DLLPUBLIC sal_Int32 SAL_CALL osl_receiveSocket(
321  oslSocket Socket,
322  void* pBuffer,
323  sal_uInt32 BytesToRead,
324  oslSocketMsgFlag Flag);
325 
347  oslSocket Socket,
348  oslSocketAddr SenderAddr,
349  void* pBuffer,
350  sal_uInt32 BufferSize,
351  oslSocketMsgFlag Flag);
352 
369 SAL_DLLPUBLIC sal_Int32 SAL_CALL osl_sendSocket(
370  oslSocket Socket,
371  const void* pBuffer,
372  sal_uInt32 BytesToSend,
373  oslSocketMsgFlag Flag);
374 
401 SAL_DLLPUBLIC sal_Int32 SAL_CALL osl_sendToSocket(
402  oslSocket Socket,
403  oslSocketAddr ReceiverAddr,
404  const void* pBuffer,
405  sal_uInt32 BytesToSend,
406  oslSocketMsgFlag Flag);
407 
421  oslSocket Socket,
422  const TimeValue* pTimeout);
423 
437  oslSocket Socket,
438  const TimeValue* pTimeout);
439 
452  oslSocket Socket,
453  const TimeValue* pTimeout);
454 
468  oslSocket Socket,
469  oslSocketDirection Direction);
470 
525  oslSocket Socket,
526  oslSocketOptionLevel Level,
527  oslSocketOption Option,
528  void* pBuffer,
529  sal_uInt32 BufferLen);
530 
549  oslSocket Socket,
550  oslSocketOptionLevel Level,
551  oslSocketOption Option,
552  void* pBuffer,
553  sal_uInt32 BufferLen);
554 
563  oslSocket Socket,
564  sal_Bool On);
565 
566 
574 
587 
594  oslSocket Socket,
595  rtl_uString **strError);
596 
604  oslSocket Socket);
605 
608 typedef struct oslSocketSetImpl * oslSocketSet;
609 
615 
619 
625 
626 
633 
640 
649 
665  oslSocketSet IncomingSet,
666  oslSocketSet OutgoingSet,
667  oslSocketSet OutOfBandSet,
668  const TimeValue* pTimeout);
669 
675 
676 
688 SAL_DLLPUBLIC sal_Int32 SAL_CALL osl_readSocket(
689  oslSocket Socket,
690  void *pBuffer,
691  sal_Int32 nSize);
692 
693 
704 SAL_DLLPUBLIC sal_Int32 SAL_CALL osl_writeSocket(
705  oslSocket Socket,
706  const void *pBuffer,
707  sal_Int32 nSize);
708 
720  oslAddrFamily Family);
721 
722 
726  oslSocketAddr Addr);
727 
733  oslSocketAddr Addr1, oslSocketAddr Addr2);
734 
741  rtl_uString *strHostname);
742 
753  rtl_uString *strDottedAddr, sal_Int32 Port);
754 
755 
764  rtl_uString *strDottedAddr, sal_Int32 Port);
765 
766 
771  oslSocketAddr Addr);
772 
778  rtl_uString *strServicename, rtl_uString *strProtocol);
779 
780 
781 
787  oslSocketAddr Addr);
788 
789 
795  oslSocketAddr Addr);
796 
797 
804  oslSocketAddr Addr, sal_Int32 Port);
805 
806 
813  oslSocketAddr Addr, rtl_uString **strHostname);
814 
815 
827  oslSocketAddr Addr, rtl_uString **strDottedInetAddr);
828 
832  oslSocketAddr Addr, sal_Sequence *pByteSeq );
833 
842  oslSocketAddr Addr, sal_Sequence **ppByteSeq );
843 
844 /*
845  Opaque datatype HostAddr.
846 */
847 typedef struct oslHostAddrImpl * oslHostAddr;
848 
849 
856  rtl_uString *strHostname, const oslSocketAddr Addr);
857 
858 
866 SAL_DLLPUBLIC oslHostAddr SAL_CALL osl_createHostAddrByName(rtl_uString *strHostname);
867 
868 
877 
878 
883 
884 
889 
890 
894 SAL_DLLPUBLIC void SAL_CALL osl_getHostnameOfHostAddr(const oslHostAddr Addr, rtl_uString **strHostname);
895 
896 
901 
908 SAL_DLLPUBLIC oslSocketResult SAL_CALL osl_getLocalHostname(rtl_uString **strLocalHostname);
909 
910 
914 #ifdef __cplusplus
915 }
916 #endif
917 
918 #endif // INCLUDED_OSL_SOCKET_H
919 
920 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
osl_Socket_OptionType
@ osl_Socket_OptionType
Definition: socket.h:108
osl_Socket_OptionAcceptConn
@ osl_Socket_OptionAcceptConn
Definition: socket.h:84
osl_Socket_E_NoBufferSpace
@ osl_Socket_E_NoBufferSpace
Definition: socket.h:172
osl_createSocket
SAL_DLLPUBLIC oslSocket osl_createSocket(oslAddrFamily Family, oslSocketType Type, oslProtocol Protocol)
Create a socket of the specified Family and Type.
osl_Socket_E_ConnReset
@ osl_Socket_E_ConnReset
Definition: socket.h:171
osl_demultiplexSocketEvents
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
@ osl_Socket_FORCE_EQUAL_SIZE
Definition: socket.h:197
osl_Socket_OptionInvalid
@ osl_Socket_OptionInvalid
Definition: socket.h:111
osl_Socket_E_MsgSize
@ osl_Socket_E_MsgSize
Definition: socket.h:155
osl_Socket_E_NetDown
@ osl_Socket_E_NetDown
Definition: socket.h:166
osl_Socket_E_OpNotSupport
@ osl_Socket_E_OpNotSupport
Definition: socket.h:160
oslProtocol
oslProtocol
represent a specific protocol within an address-family
Definition: socket.h:52
osl_getSocketType
SAL_DLLPUBLIC oslSocketType osl_getSocketType(oslSocket Socket)
Queries the socket for its type.
osl_Socket_Interrupted
@ osl_Socket_Interrupted
Definition: socket.h:195
osl_removeFromSocketSet
SAL_DLLPUBLIC void osl_removeFromSocketSet(oslSocketSet Set, oslSocket Socket)
Removes a socket from the set.
osl_isNonBlockingMode
SAL_DLLPUBLIC sal_Bool osl_isNonBlockingMode(oslSocket Socket)
Query state of non-blocking-mode of the socket.
osl_Socket_OptionUseLoopback
@ osl_Socket_OptionUseLoopback
Definition: socket.h:90
osl_Socket_E_NotSocket
@ osl_Socket_E_NotSocket
Definition: socket.h:153
osl_Socket_E_AddrInUse
@ osl_Socket_E_AddrInUse
Definition: socket.h:164
oslSocketDirection
oslSocketDirection
Used by shutdown to denote which end of the socket to "close".
Definition: socket.h:141
osl_shutdownSocket
SAL_DLLPUBLIC sal_Bool osl_shutdownSocket(oslSocket Socket, oslSocketDirection Direction)
Shuts down communication on a connected socket.
osl_sendToSocket
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...
osl_isReceiveReady
SAL_DLLPUBLIC sal_Bool osl_isReceiveReady(oslSocket Socket, const TimeValue *pTimeout)
Checks if read operations will block.
osl_Socket_DirWrite
@ osl_Socket_DirWrite
Definition: socket.h:143
osl_Socket_LevelSocket
@ osl_Socket_LevelSocket
Definition: socket.h:119
osl_getServicePort
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
@ osl_Socket_MsgPeek
Definition: socket.h:131
osl_Socket_E_Shutdown
@ osl_Socket_E_Shutdown
Definition: socket.h:175
osl_Socket_OptionSndLowat
@ osl_Socket_OptionSndLowat
Definition: socket.h:99
osl_Socket_LevelInvalid
@ osl_Socket_LevelInvalid
Definition: socket.h:121
osl_Socket_OptionRcvBuf
@ osl_Socket_OptionRcvBuf
Definition: socket.h:98
oslSocketType
oslSocketType
Represents the type of a socket.
Definition: socket.h:64
oslSocketIpxNetNumber
sal_uInt8 oslSocketIpxNetNumber[4]
Definition: socket.h:200
osl_connectSocketTo
SAL_DLLPUBLIC oslSocketResult osl_connectSocketTo(oslSocket Socket, oslSocketAddr Addr, const TimeValue *pTimeout)
Connects the socket to the given address.
osl_copyHostAddr
SAL_DLLPUBLIC oslHostAddr osl_copyHostAddr(const oslHostAddr Addr)
Create a copy of the given Addr.
osl_setInetPortOfSocketAddr
SAL_DLLPUBLIC sal_Bool osl_setInetPortOfSocketAddr(oslSocketAddr Addr, sal_Int32 Port)
Sets the Port of Addr.
time.h
osl_Socket_TypeRaw
@ osl_Socket_TypeRaw
Definition: socket.h:67
osl_setSocketOption
SAL_DLLPUBLIC sal_Bool osl_setSocketOption(oslSocket Socket, oslSocketOptionLevel Level, oslSocketOption Option, void *pBuffer, sal_uInt32 BufferLen)
Sets the sockets attributes.
sal_uInt8
unsigned char sal_uInt8
Definition: types.h:44
osl_Socket_E_FORCE_EQUAL_SIZE
@ osl_Socket_E_FORCE_EQUAL_SIZE
Definition: socket.h:185
osl_writeSocket
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
@ osl_Socket_OptionOOBinLine
Definition: socket.h:95
osl_Socket_OptionKeepAlive
@ osl_Socket_OptionKeepAlive
Definition: socket.h:86
osl_Socket_E_TooManyRefs
@ osl_Socket_E_TooManyRefs
Definition: socket.h:176
osl_getHostnameOfSocketAddr
SAL_DLLPUBLIC oslSocketResult osl_getHostnameOfSocketAddr(oslSocketAddr Addr, rtl_uString **strHostname)
Returns the hostname represented by Addr.
osl_Socket_E_AddrNotAvail
@ osl_Socket_E_AddrNotAvail
Definition: socket.h:165
osl_Socket_MsgInvalid
@ osl_Socket_MsgInvalid
Definition: socket.h:134
osl_createHostAddrByName
SAL_DLLPUBLIC oslHostAddr osl_createHostAddrByName(rtl_uString *strHostname)
Create an oslHostAddr by resolving the given strHostname.
osl_Socket_E_ConnAborted
@ osl_Socket_E_ConnAborted
Definition: socket.h:170
osl_Socket_OptionRcvTimeo
@ osl_Socket_OptionRcvTimeo
Definition: socket.h:106
osl_Socket_ProtocolInvalid
@ osl_Socket_ProtocolInvalid
Definition: socket.h:57
osl_createInetBroadcastAddr
SAL_DLLPUBLIC oslSocketAddr osl_createInetBroadcastAddr(rtl_uString *strDottedAddr, sal_Int32 Port)
Create an internet address usable for sending broadcast datagrams.
osl_Socket_DirInvalid
@ osl_Socket_DirInvalid
Definition: socket.h:145
osl_createHostAddrByAddr
SAL_DLLPUBLIC oslHostAddr osl_createHostAddrByAddr(const oslSocketAddr Addr)
Create an oslHostAddr by reverse resolution of the given Addr.
sal_Bool
unsigned char sal_Bool
Definition: types.h:38
ustring.h
osl_Socket_E_PfNoSupport
@ osl_Socket_E_PfNoSupport
Definition: socket.h:161
osl_Socket_OptionReuseAddr
@ osl_Socket_OptionReuseAddr
Definition: socket.h:85
oslHostAddr
struct oslHostAddrImpl * oslHostAddr
Definition: socket.h:847
oslSocketMsgFlag
oslSocketMsgFlag
Represents flags to be used with send/recv-calls.
Definition: socket.h:128
osl_createHostAddr
SAL_DLLPUBLIC oslHostAddr osl_createHostAddr(rtl_uString *strHostname, const oslSocketAddr Addr)
Create an oslHostAddr from given hostname and socket address.
osl_Socket_FamilyIpx
@ osl_Socket_FamilyIpx
Definition: socket.h:44
osl_getInetPortOfSocketAddr
SAL_DLLPUBLIC sal_Int32 osl_getInetPortOfSocketAddr(oslSocketAddr Addr)
Retrieves the internet port-number of Addr.
osl_Socket_OptionTcpNoDelay
@ osl_Socket_OptionTcpNoDelay
Definition: socket.h:110
osl_Socket_ProtocolIp
@ osl_Socket_ProtocolIp
Definition: socket.h:53
osl_getFamilyOfSocketAddr
SAL_DLLPUBLIC oslAddrFamily osl_getFamilyOfSocketAddr(oslSocketAddr Addr)
Retrieves the address-family from the Addr.
osl_isEqualSocketAddr
SAL_DLLPUBLIC sal_Bool osl_isEqualSocketAddr(oslSocketAddr Addr1, oslSocketAddr Addr2)
Compares the values of two SocketAddresses.
osl_Socket_FamilyInvalid
@ osl_Socket_FamilyInvalid
Definition: socket.h:45
osl_Socket_E_Prototype
@ osl_Socket_E_Prototype
Definition: socket.h:156
osl_Socket_InProgress
@ osl_Socket_InProgress
Definition: socket.h:196
osl_Socket_E_NetReset
@ osl_Socket_E_NetReset
Definition: socket.h:168
oslSocket
struct oslSocketImpl * oslSocket
Definition: socket.h:209
osl_destroyHostAddr
SAL_DLLPUBLIC void osl_destroyHostAddr(oslHostAddr Addr)
Frees all resources allocated by Addr.
osl_Socket_Protocol_FORCE_EQUAL_SIZE
@ osl_Socket_Protocol_FORCE_EQUAL_SIZE
Definition: socket.h:58
osl_receiveSocket
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.
osl_createInetSocketAddr
SAL_DLLPUBLIC oslSocketAddr osl_createInetSocketAddr(rtl_uString *strDottedAddr, sal_Int32 Port)
Create an internet-address, consisting of host address and port.
oslSocketAddr
struct oslSocketAddrImpl * oslSocketAddr
Opaque datatype SocketAddr.
Definition: socket.h:37
oslSocketResult
oslSocketResult
Common return codes of socket related functions.
Definition: socket.h:190
osl_Socket_Msg_FORCE_EQUAL_SIZE
@ osl_Socket_Msg_FORCE_EQUAL_SIZE
Definition: socket.h:135
SAL_DLLPUBLIC
#define SAL_DLLPUBLIC
Definition: saldllapi.h:30
osl_Socket_OptionError
@ osl_Socket_OptionError
Definition: socket.h:107
osl_Socket_ProtocolSpx
@ osl_Socket_ProtocolSpx
Definition: socket.h:55
osl_Socket_DirRead
@ osl_Socket_DirRead
Definition: socket.h:142
osl_addToSocketSet
SAL_DLLPUBLIC void osl_addToSocketSet(oslSocketSet Set, oslSocket Socket)
Adds a socket to the set.
osl_isInSocketSet
SAL_DLLPUBLIC sal_Bool osl_isInSocketSet(oslSocketSet Set, oslSocket Socket)
Checks if socket is in the set.
osl_Socket_E_ConnRefused
@ osl_Socket_E_ConnRefused
Definition: socket.h:178
osl_Socket_E_NetUnreachable
@ osl_Socket_E_NetUnreachable
Definition: socket.h:167
oslSocketOption
oslSocketOption
Represents socket-options.
Definition: socket.h:82
osl_getAddrOfSocketAddr
SAL_DLLPUBLIC oslSocketResult osl_getAddrOfSocketAddr(oslSocketAddr Addr, sal_Sequence **ppByteSeq)
Returns the addr field in the struct sockaddr.
osl_getHostnameOfHostAddr
SAL_DLLPUBLIC void osl_getHostnameOfHostAddr(const oslHostAddr Addr, rtl_uString **strHostname)
Get the hostname member of Addr.
oslSocketError
oslSocketError
Describes the various error socket error conditions, which may occur.
Definition: socket.h:151
osl_Socket_MsgNormal
@ osl_Socket_MsgNormal
Definition: socket.h:129
osl_Socket_E_TypeNoSupport
@ osl_Socket_E_TypeNoSupport
Definition: socket.h:159
osl_Socket_Type_FORCE_EQUAL_SIZE
@ osl_Socket_Type_FORCE_EQUAL_SIZE
Definition: socket.h:75
osl_bindAddrToSocket
SAL_DLLPUBLIC sal_Bool osl_bindAddrToSocket(oslSocket Socket, oslSocketAddr Addr)
Binds the given address to the socket.
osl_Socket_TimedOut
@ osl_Socket_TimedOut
Definition: socket.h:194
osl_getLocalHostname
SAL_DLLPUBLIC oslSocketResult osl_getLocalHostname(rtl_uString **strLocalHostname)
Retrieve this machines hostname.
osl_Socket_E_NotConnected
@ osl_Socket_E_NotConnected
Definition: socket.h:174
osl_Socket_OptionLinger
@ osl_Socket_OptionLinger
Definition: socket.h:92
osl_getSocketAddrOfHostAddr
SAL_DLLPUBLIC oslSocketAddr osl_getSocketAddrOfHostAddr(const oslHostAddr Addr)
Get the socket address member of Addr.
osl_Socket_OptionDontRoute
@ osl_Socket_OptionDontRoute
Definition: socket.h:87
osl_closeSocket
SAL_DLLPUBLIC void osl_closeSocket(oslSocket Socket)
Closes the socket terminating any ongoing dataflow.
osl_Socket_E_ProtocolNoSupport
@ osl_Socket_E_ProtocolNoSupport
Definition: socket.h:158
osl_Socket_E_WouldBlock
@ osl_Socket_E_WouldBlock
Definition: socket.h:181
osl_Socket_E_HostDown
@ osl_Socket_E_HostDown
Definition: socket.h:179
osl_Socket_E_InvalidError
@ osl_Socket_E_InvalidError
Definition: socket.h:184
osl_Socket_E_NoProtocol
@ osl_Socket_E_NoProtocol
Definition: socket.h:157
TimeValue
Definition: time.h:66
osl_Socket_MsgOOB
@ osl_Socket_MsgOOB
Definition: socket.h:130
osl_sendSocket
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
@ osl_Socket_E_Already
Definition: socket.h:182
osl_Socket_E_TimedOut
@ osl_Socket_E_TimedOut
Definition: socket.h:177
osl_Socket_Level_FORCE_EQUAL_SIZE
@ osl_Socket_Level_FORCE_EQUAL_SIZE
Definition: socket.h:122
osl_Socket_Option_FORCE_EQUAL_SIZE
@ osl_Socket_Option_FORCE_EQUAL_SIZE
Definition: socket.h:112
osl_Socket_ProtocolSpxII
@ osl_Socket_ProtocolSpxII
Definition: socket.h:56
osl_Socket_MsgDontRoute
@ osl_Socket_MsgDontRoute
Definition: socket.h:132
osl_clearSocketSet
SAL_DLLPUBLIC void osl_clearSocketSet(oslSocketSet Set)
Clears the set from all previously added sockets.
osl_Socket_TypeSeqPacket
@ osl_Socket_TypeSeqPacket
Definition: socket.h:71
osl_createEmptySocketAddr
SAL_DLLPUBLIC oslSocketAddr osl_createEmptySocketAddr(oslAddrFamily Family)
Creates a socket-address for the given family.
osl_receiveFromSocket
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,...
osl_destroySocketSet
SAL_DLLPUBLIC void osl_destroySocketSet(oslSocketSet Set)
Destroys an oslSocketSet.
osl_Socket_OptionSndBuf
@ osl_Socket_OptionSndBuf
Definition: socket.h:97
osl_Socket_OptionDebug
@ osl_Socket_OptionDebug
Definition: socket.h:83
SAL_MAX_ENUM
#define SAL_MAX_ENUM
Definition: types.h:223
_sal_Sequence
This is the binary specification of a SAL sequence.
Definition: types.h:322
osl_Socket_MsgMaxIOVLen
@ osl_Socket_MsgMaxIOVLen
Definition: socket.h:133
osl_getSocketOption
SAL_DLLPUBLIC sal_Int32 osl_getSocketOption(oslSocket Socket, oslSocketOptionLevel Level, oslSocketOption Option, void *pBuffer, sal_uInt32 BufferLen)
Retrieves attributes associated with the socket.
osl_createSocketSet
SAL_DLLPUBLIC oslSocketSet osl_createSocketSet(void)
Creates a set of sockets to be used with osl_demultiplexSocketEvents().
osl_getLocalAddrOfSocket
SAL_DLLPUBLIC oslSocketAddr osl_getLocalAddrOfSocket(oslSocket Socket)
Retrieves the Address of the local end of the socket.
osl_getDottedInetAddrOfSocketAddr
SAL_DLLPUBLIC oslSocketResult osl_getDottedInetAddrOfSocketAddr(oslSocketAddr Addr, rtl_uString **strDottedInetAddr)
Gets the address in dotted decimal format.
osl_Socket_E_InProgress
@ osl_Socket_E_InProgress
Definition: socket.h:183
osl_Socket_TypeInvalid
@ osl_Socket_TypeInvalid
Definition: socket.h:74
osl_Socket_ProtocolIpx
@ osl_Socket_ProtocolIpx
Definition: socket.h:54
osl_isExceptionPending
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
@ osl_Socket_Ok
Definition: socket.h:191
osl_Socket_FamilyInet
@ osl_Socket_FamilyInet
Definition: socket.h:43
osl_Socket_TypeStream
@ osl_Socket_TypeStream
Definition: socket.h:65
osl_acceptConnectionOnSocket
SAL_DLLPUBLIC oslSocket osl_acceptConnectionOnSocket(oslSocket Socket, oslSocketAddr *pAddr)
Waits for an ingoing connection on the socket.
osl_Socket_E_HostUnreachable
@ osl_Socket_E_HostUnreachable
Definition: socket.h:180
osl_acquireSocket
SAL_DLLPUBLIC void osl_acquireSocket(oslSocket Socket)
increases the refcount of the socket handle by one
osl_destroySocketAddr
SAL_DLLPUBLIC void osl_destroySocketAddr(oslSocketAddr Addr)
Frees all resources allocated by Addr.
osl_Socket_Family_FORCE_EQUAL_SIZE
@ osl_Socket_Family_FORCE_EQUAL_SIZE
Definition: socket.h:46
oslSocketSet
struct oslSocketSetImpl * oslSocketSet
Type for the representation of socket sets.
Definition: socket.h:608
osl_listenOnSocket
SAL_DLLPUBLIC sal_Bool osl_listenOnSocket(oslSocket Socket, sal_Int32 MaxPendingConnections)
Prepares the socket to act as an acceptor of incoming connections.
osl_readSocket
SAL_DLLPUBLIC sal_Int32 osl_readSocket(oslSocket Socket, void *pBuffer, sal_Int32 nSize)
Retrieves n bytes from the stream and copies them into pBuffer.
osl_isSendReady
SAL_DLLPUBLIC sal_Bool osl_isSendReady(oslSocket Socket, const TimeValue *pTimeout)
Checks if send operations will block.
osl_getLastSocketError
SAL_DLLPUBLIC oslSocketError osl_getLastSocketError(oslSocket Socket)
Returns a constant describing the last error for the socket system.
osl_Socket_OptionBroadcast
@ osl_Socket_OptionBroadcast
Definition: socket.h:89
osl_getPeerAddrOfSocket
SAL_DLLPUBLIC oslSocketAddr osl_getPeerAddrOfSocket(oslSocket Socket)
Retrieves the Address of the remote end of the socket.
oslSocketIpxNodeNumber
sal_uInt8 oslSocketIpxNodeNumber[6]
Definition: socket.h:201
osl_setAddrOfSocketAddr
SAL_DLLPUBLIC oslSocketResult osl_setAddrOfSocketAddr(oslSocketAddr Addr, sal_Sequence *pByteSeq)
Sets the addr field in the struct sockaddr with pByteSeq.
oslAddrFamily
oslAddrFamily
Represents the address-family of a socket.
Definition: socket.h:42
oslSocketOptionLevel
oslSocketOptionLevel
Represents the different socket-option levels.
Definition: socket.h:118
osl_Socket_TypeDgram
@ osl_Socket_TypeDgram
Definition: socket.h:66
osl_Socket_E_None
@ osl_Socket_E_None
Definition: socket.h:152
osl_Socket_E_DestAddrReq
@ osl_Socket_E_DestAddrReq
Definition: socket.h:154
osl_Socket_Error
@ osl_Socket_Error
Definition: socket.h:192
osl_Socket_LevelTcp
@ osl_Socket_LevelTcp
Definition: socket.h:120
osl_getLastSocketErrorDescription
SAL_DLLPUBLIC void osl_getLastSocketErrorDescription(oslSocket Socket, rtl_uString **strError)
returns a string which describes the last socket error.
osl_Socket_E_IsConnected
@ osl_Socket_E_IsConnected
Definition: socket.h:173
osl_Socket_E_AfNoSupport
@ osl_Socket_E_AfNoSupport
Definition: socket.h:162
osl_Socket_OptionSndTimeo
@ osl_Socket_OptionSndTimeo
Definition: socket.h:105
osl_Socket_Dir_FORCE_EQUAL_SIZE
@ osl_Socket_Dir_FORCE_EQUAL_SIZE
Definition: socket.h:146
osl_copySocketAddr
SAL_DLLPUBLIC oslSocketAddr osl_copySocketAddr(oslSocketAddr Addr)
Creates a new SocketAddress and fills it from Addr.
osl_Socket_TypeRdm
@ osl_Socket_TypeRdm
Definition: socket.h:68
osl_Socket_OptionRcvLowat
@ osl_Socket_OptionRcvLowat
Definition: socket.h:102
osl_resolveHostname
SAL_DLLPUBLIC oslSocketAddr osl_resolveHostname(rtl_uString *strHostname)
Uses the systems name-service interface to find an address for strHostname.
osl_enableNonBlockingMode
SAL_DLLPUBLIC sal_Bool osl_enableNonBlockingMode(oslSocket Socket, sal_Bool On)
Enables/disables non-blocking-mode of the socket.
osl_Socket_DirReadWrite
@ osl_Socket_DirReadWrite
Definition: socket.h:144
osl_releaseSocket
SAL_DLLPUBLIC void osl_releaseSocket(oslSocket Socket)
decreases the refcount of the socket handle by one.