LibreOffice
LibreOffice 7.1 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
27extern "C" {
28#endif
29
30/* error returns */
31#define OSL_INADDR_NONE 0xffffffff
32#define OSL_INVALID_PORT (-1)
33
40typedef struct oslSocketAddrImpl * oslSocketAddr;
41
45typedef enum {
51
55typedef enum {
63
67typedef enum {
80
81
85typedef enum {
117
121typedef enum {
127
131typedef enum {
140
144typedef enum {
151
154typedef enum {
190
193typedef enum {
202
205
212typedef struct oslSocketImpl * oslSocket;
213
221 oslAddrFamily Family,
222 oslSocketType Type,
223 oslProtocol Protocol);
224
228
235
244
252
261 oslSocket Socket,
262 oslSocketAddr Addr);
263
276 oslSocket Socket,
277 oslSocketAddr Addr,
278 const TimeValue* pTimeout);
279
280
290 oslSocket Socket,
291 sal_Int32 MaxPendingConnections);
292
293
302 oslSocket Socket,
303 oslSocketAddr* pAddr);
304
324 oslSocket Socket,
325 void* pBuffer,
326 sal_uInt32 BytesToRead,
327 oslSocketMsgFlag Flag);
328
350 oslSocket Socket,
351 oslSocketAddr SenderAddr,
352 void* pBuffer,
353 sal_uInt32 BufferSize,
354 oslSocketMsgFlag Flag);
355
372SAL_DLLPUBLIC sal_Int32 SAL_CALL osl_sendSocket(
373 oslSocket Socket,
374 const void* pBuffer,
375 sal_uInt32 BytesToSend,
376 oslSocketMsgFlag Flag);
377
405 oslSocket Socket,
406 oslSocketAddr ReceiverAddr,
407 const void* pBuffer,
408 sal_uInt32 BytesToSend,
409 oslSocketMsgFlag Flag);
410
424 oslSocket Socket,
425 const TimeValue* pTimeout);
426
440 oslSocket Socket,
441 const TimeValue* pTimeout);
442
455 oslSocket Socket,
456 const TimeValue* pTimeout);
457
471 oslSocket Socket,
472 oslSocketDirection Direction);
473
528 oslSocket Socket,
530 oslSocketOption Option,
531 void* pBuffer,
532 sal_uInt32 BufferLen);
533
552 oslSocket Socket,
554 oslSocketOption Option,
555 void* pBuffer,
556 sal_uInt32 BufferLen);
557
566 oslSocket Socket,
567 sal_Bool On);
568
569
577
590
597 oslSocket Socket,
598 rtl_uString **strError);
599
607 oslSocket Socket);
608
611typedef struct oslSocketSetImpl * oslSocketSet;
612
618
622
628
629
636
643
652
668 oslSocketSet IncomingSet,
669 oslSocketSet OutgoingSet,
670 oslSocketSet OutOfBandSet,
671 const TimeValue* pTimeout);
672
678
679
691SAL_DLLPUBLIC sal_Int32 SAL_CALL osl_readSocket(
692 oslSocket Socket,
693 void *pBuffer,
694 sal_Int32 nSize);
695
696
708 oslSocket Socket,
709 const void *pBuffer,
710 sal_Int32 nSize);
711
723 oslAddrFamily Family);
724
725
729 oslSocketAddr Addr);
730
736 oslSocketAddr Addr1, oslSocketAddr Addr2);
737
744 rtl_uString *strHostname);
745
756 rtl_uString *strDottedAddr, sal_Int32 Port);
757
758
767 rtl_uString *strDottedAddr, sal_Int32 Port);
768
769
774 oslSocketAddr Addr);
775
781 rtl_uString *strServicename, rtl_uString *strProtocol);
782
783
784
790 oslSocketAddr Addr);
791
792
798 oslSocketAddr Addr);
799
800
807 oslSocketAddr Addr, sal_Int32 Port);
808
809
816 oslSocketAddr Addr, rtl_uString **strHostname);
817
818
830 oslSocketAddr Addr, rtl_uString **strDottedInetAddr);
831
835 oslSocketAddr Addr, sal_Sequence *pByteSeq );
836
845 oslSocketAddr Addr, sal_Sequence **ppByteSeq );
846
847/*
848 Opaque datatype HostAddr.
849*/
850typedef struct oslHostAddrImpl * oslHostAddr;
851
852
859 rtl_uString *strHostname, const oslSocketAddr Addr);
860
861
869SAL_DLLPUBLIC oslHostAddr SAL_CALL osl_createHostAddrByName(rtl_uString *strHostname);
870
871
880
881
886
887
892
893
897SAL_DLLPUBLIC void SAL_CALL osl_getHostnameOfHostAddr(const oslHostAddr Addr, rtl_uString **strHostname);
898
899
904
911SAL_DLLPUBLIC oslSocketResult SAL_CALL osl_getLocalHostname(rtl_uString **strLocalHostname);
912
913
917#ifdef __cplusplus
918}
919#endif
920
921#endif // INCLUDED_OSL_SOCKET_H
922
923/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
#define SAL_DLLPUBLIC
Definition: saldllapi.h:30
#define SAL_MAX_ENUM
Definition: types.h:201
unsigned char sal_uInt8
Definition: types.h:40
unsigned char sal_Bool
Definition: types.h:34
oslSocketOption
Represents socket-options.
Definition: socket.h:85
@ osl_Socket_OptionSndBuf
Definition: socket.h:100
@ osl_Socket_OptionTcpNoDelay
Definition: socket.h:113
@ osl_Socket_OptionSndLowat
Definition: socket.h:102
@ osl_Socket_OptionSndTimeo
Definition: socket.h:108
@ osl_Socket_OptionDebug
Definition: socket.h:86
@ osl_Socket_OptionReuseAddr
Definition: socket.h:88
@ osl_Socket_OptionDontRoute
Definition: socket.h:90
@ osl_Socket_OptionRcvLowat
Definition: socket.h:105
@ osl_Socket_OptionRcvBuf
Definition: socket.h:101
@ osl_Socket_OptionType
Definition: socket.h:111
@ osl_Socket_OptionError
Definition: socket.h:110
@ osl_Socket_OptionAcceptConn
Definition: socket.h:87
@ osl_Socket_OptionInvalid
Definition: socket.h:114
@ osl_Socket_OptionKeepAlive
Definition: socket.h:89
@ osl_Socket_OptionOOBinLine
Definition: socket.h:98
@ osl_Socket_Option_FORCE_EQUAL_SIZE
Definition: socket.h:115
@ osl_Socket_OptionBroadcast
Definition: socket.h:92
@ osl_Socket_OptionLinger
Definition: socket.h:95
@ osl_Socket_OptionUseLoopback
Definition: socket.h:93
@ osl_Socket_OptionRcvTimeo
Definition: socket.h:109
SAL_DLLPUBLIC sal_Bool osl_setInetPortOfSocketAddr(oslSocketAddr Addr, sal_Int32 Port)
Sets the Port of Addr.
struct oslSocketSetImpl * oslSocketSet
Type for the representation of socket sets.
Definition: socket.h:611
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 sal_Int32 osl_getInetPortOfSocketAddr(oslSocketAddr Addr)
Retrieves the internet port-number of Addr.
SAL_DLLPUBLIC void osl_addToSocketSet(oslSocketSet Set, oslSocket Socket)
Adds a socket to the set.
SAL_DLLPUBLIC oslSocketResult osl_getAddrOfSocketAddr(oslSocketAddr Addr, sal_Sequence **ppByteSeq)
Returns the addr field in the struct sockaddr.
SAL_DLLPUBLIC sal_Bool osl_listenOnSocket(oslSocket Socket, sal_Int32 MaxPendingConnections)
Prepares the socket to act as an acceptor of incoming connections.
SAL_DLLPUBLIC oslHostAddr osl_createHostAddrByName(rtl_uString *strHostname)
Create an oslHostAddr by resolving the given strHostname.
SAL_DLLPUBLIC oslHostAddr osl_createHostAddrByAddr(const oslSocketAddr Addr)
Create an oslHostAddr by reverse resolution of the given Addr.
SAL_DLLPUBLIC sal_Int32 osl_demultiplexSocketEvents(oslSocketSet IncomingSet, oslSocketSet OutgoingSet, oslSocketSet OutOfBandSet, const TimeValue *pTimeout)
Checks multiple sockets for events.
oslSocketResult
Common return codes of socket related functions.
Definition: socket.h:193
@ osl_Socket_InProgress
Definition: socket.h:199
@ osl_Socket_Ok
Definition: socket.h:194
@ osl_Socket_Error
Definition: socket.h:195
@ osl_Socket_FORCE_EQUAL_SIZE
Definition: socket.h:200
@ osl_Socket_TimedOut
Definition: socket.h:197
@ osl_Socket_Interrupted
Definition: socket.h:198
struct oslSocketAddrImpl * oslSocketAddr
Opaque datatype SocketAddr.
Definition: socket.h:40
SAL_DLLPUBLIC sal_Bool osl_bindAddrToSocket(oslSocket Socket, oslSocketAddr Addr)
Binds the given address to the socket.
SAL_DLLPUBLIC oslSocket osl_acceptConnectionOnSocket(oslSocket Socket, oslSocketAddr *pAddr)
Waits for an ingoing connection on the socket.
SAL_DLLPUBLIC void osl_getHostnameOfHostAddr(const oslHostAddr Addr, rtl_uString **strHostname)
Get the hostname member of Addr.
struct oslHostAddrImpl * oslHostAddr
Definition: socket.h:850
SAL_DLLPUBLIC void osl_closeSocket(oslSocket Socket)
Closes the socket terminating any ongoing dataflow.
SAL_DLLPUBLIC void osl_acquireSocket(oslSocket Socket)
increases the refcount of the socket handle by one
SAL_DLLPUBLIC oslHostAddr osl_createHostAddr(rtl_uString *strHostname, const oslSocketAddr Addr)
Create an oslHostAddr from given hostname and socket address.
SAL_DLLPUBLIC sal_Bool osl_isSendReady(oslSocket Socket, const TimeValue *pTimeout)
Checks if send operations will block.
SAL_DLLPUBLIC oslSocketResult osl_setAddrOfSocketAddr(oslSocketAddr Addr, sal_Sequence *pByteSeq)
Sets the addr field in the struct sockaddr with pByteSeq.
SAL_DLLPUBLIC oslSocketResult osl_getDottedInetAddrOfSocketAddr(oslSocketAddr Addr, rtl_uString **strDottedInetAddr)
Gets the address in dotted decimal format.
SAL_DLLPUBLIC void osl_releaseSocket(oslSocket Socket)
decreases the refcount of the socket handle by one.
oslSocketType
Represents the type of a socket.
Definition: socket.h:67
@ osl_Socket_TypeStream
Definition: socket.h:68
@ osl_Socket_TypeRdm
Definition: socket.h:71
@ osl_Socket_TypeSeqPacket
Definition: socket.h:74
@ osl_Socket_Type_FORCE_EQUAL_SIZE
Definition: socket.h:78
@ osl_Socket_TypeInvalid
Definition: socket.h:77
@ osl_Socket_TypeRaw
Definition: socket.h:70
@ osl_Socket_TypeDgram
Definition: socket.h:69
SAL_DLLPUBLIC oslSocketError osl_getLastSocketError(oslSocket Socket)
Returns a constant describing the last error for the socket system.
SAL_DLLPUBLIC oslSocketAddr osl_createInetBroadcastAddr(rtl_uString *strDottedAddr, sal_Int32 Port)
Create an internet address usable for sending broadcast datagrams.
SAL_DLLPUBLIC sal_Bool osl_isNonBlockingMode(oslSocket Socket)
Query state of non-blocking-mode of the socket.
SAL_DLLPUBLIC void osl_destroySocketAddr(oslSocketAddr Addr)
Frees all resources allocated by Addr.
SAL_DLLPUBLIC oslSocketAddr osl_getLocalAddrOfSocket(oslSocket Socket)
Retrieves the Address of the local end of the socket.
SAL_DLLPUBLIC sal_Bool osl_isReceiveReady(oslSocket Socket, const TimeValue *pTimeout)
Checks if read operations will block.
SAL_DLLPUBLIC oslSocketType osl_getSocketType(oslSocket Socket)
Queries the socket for its type.
SAL_DLLPUBLIC sal_Bool osl_setSocketOption(oslSocket Socket, oslSocketOptionLevel Level, oslSocketOption Option, void *pBuffer, sal_uInt32 BufferLen)
Sets the sockets attributes.
struct oslSocketImpl * oslSocket
Definition: socket.h:212
SAL_DLLPUBLIC void osl_destroySocketSet(oslSocketSet Set)
Destroys an oslSocketSet.
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 oslSocket osl_createSocket(oslAddrFamily Family, oslSocketType Type, oslProtocol Protocol)
Create a socket of the specified Family and Type.
SAL_DLLPUBLIC void osl_removeFromSocketSet(oslSocketSet Set, oslSocket Socket)
Removes a socket from the set.
SAL_DLLPUBLIC sal_Int32 osl_writeSocket(oslSocket Socket, const void *pBuffer, sal_Int32 nSize)
Writes n bytes from pBuffer to the stream.
oslSocketOptionLevel
Represents the different socket-option levels.
Definition: socket.h:121
@ osl_Socket_LevelTcp
Definition: socket.h:123
@ osl_Socket_LevelInvalid
Definition: socket.h:124
@ osl_Socket_Level_FORCE_EQUAL_SIZE
Definition: socket.h:125
@ osl_Socket_LevelSocket
Definition: socket.h:122
SAL_DLLPUBLIC oslSocketAddr osl_createInetSocketAddr(rtl_uString *strDottedAddr, sal_Int32 Port)
Create an internet-address, consisting of host address and port.
SAL_DLLPUBLIC oslHostAddr osl_copyHostAddr(const oslHostAddr Addr)
Create a copy of the given Addr.
SAL_DLLPUBLIC oslSocketAddr osl_createEmptySocketAddr(oslAddrFamily Family)
Creates a socket-address for the given family.
SAL_DLLPUBLIC sal_Bool osl_isInSocketSet(oslSocketSet Set, oslSocket Socket)
Checks if socket is in the set.
SAL_DLLPUBLIC oslSocketAddr osl_getPeerAddrOfSocket(oslSocket Socket)
Retrieves the Address of the remote end of the socket.
oslSocketDirection
Used by shutdown to denote which end of the socket to "close".
Definition: socket.h:144
@ osl_Socket_DirRead
Definition: socket.h:145
@ osl_Socket_DirWrite
Definition: socket.h:146
@ osl_Socket_DirInvalid
Definition: socket.h:148
@ osl_Socket_Dir_FORCE_EQUAL_SIZE
Definition: socket.h:149
@ osl_Socket_DirReadWrite
Definition: socket.h:147
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_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_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.
SAL_DLLPUBLIC sal_Bool osl_enableNonBlockingMode(oslSocket Socket, sal_Bool On)
Enables/disables non-blocking-mode of the socket.
oslProtocol
represent a specific protocol within an address-family
Definition: socket.h:55
@ osl_Socket_ProtocolIpx
Definition: socket.h:57
@ osl_Socket_ProtocolInvalid
Definition: socket.h:60
@ osl_Socket_ProtocolSpx
Definition: socket.h:58
@ osl_Socket_Protocol_FORCE_EQUAL_SIZE
Definition: socket.h:61
@ osl_Socket_ProtocolSpxII
Definition: socket.h:59
@ osl_Socket_ProtocolIp
Definition: socket.h:56
oslSocketError
Describes the various error socket error conditions, which may occur.
Definition: socket.h:154
@ osl_Socket_E_ProtocolNoSupport
Definition: socket.h:161
@ osl_Socket_E_TimedOut
Definition: socket.h:180
@ osl_Socket_E_WouldBlock
Definition: socket.h:184
@ osl_Socket_E_NetUnreachable
Definition: socket.h:170
@ osl_Socket_E_DestAddrReq
Definition: socket.h:157
@ osl_Socket_E_Already
Definition: socket.h:185
@ osl_Socket_E_HostUnreachable
Definition: socket.h:183
@ osl_Socket_E_HostDown
Definition: socket.h:182
@ osl_Socket_E_NotSocket
Definition: socket.h:156
@ osl_Socket_E_IsConnected
Definition: socket.h:176
@ osl_Socket_E_Shutdown
Definition: socket.h:178
@ osl_Socket_E_ConnAborted
Definition: socket.h:173
@ osl_Socket_E_TooManyRefs
Definition: socket.h:179
@ osl_Socket_E_TypeNoSupport
Definition: socket.h:162
@ osl_Socket_E_MsgSize
Definition: socket.h:158
@ osl_Socket_E_NetReset
Definition: socket.h:171
@ osl_Socket_E_PfNoSupport
Definition: socket.h:164
@ osl_Socket_E_AfNoSupport
Definition: socket.h:165
@ osl_Socket_E_None
Definition: socket.h:155
@ osl_Socket_E_InProgress
Definition: socket.h:186
@ osl_Socket_E_AddrInUse
Definition: socket.h:167
@ osl_Socket_E_Prototype
Definition: socket.h:159
@ osl_Socket_E_ConnReset
Definition: socket.h:174
@ osl_Socket_E_NotConnected
Definition: socket.h:177
@ osl_Socket_E_NoBufferSpace
Definition: socket.h:175
@ osl_Socket_E_NoProtocol
Definition: socket.h:160
@ osl_Socket_E_OpNotSupport
Definition: socket.h:163
@ osl_Socket_E_ConnRefused
Definition: socket.h:181
@ osl_Socket_E_FORCE_EQUAL_SIZE
Definition: socket.h:188
@ osl_Socket_E_NetDown
Definition: socket.h:169
@ osl_Socket_E_InvalidError
Definition: socket.h:187
@ osl_Socket_E_AddrNotAvail
Definition: socket.h:168
sal_uInt8 oslSocketIpxNetNumber[4]
Definition: socket.h:203
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_uInt8 oslSocketIpxNodeNumber[6]
Definition: socket.h:204
oslAddrFamily
Represents the address-family of a socket.
Definition: socket.h:45
@ osl_Socket_FamilyInvalid
Definition: socket.h:48
@ osl_Socket_Family_FORCE_EQUAL_SIZE
Definition: socket.h:49
@ osl_Socket_FamilyInet
Definition: socket.h:46
@ osl_Socket_FamilyIpx
Definition: socket.h:47
SAL_DLLPUBLIC oslSocketResult osl_connectSocketTo(oslSocket Socket, oslSocketAddr Addr, const TimeValue *pTimeout)
Connects the socket to the given address.
SAL_DLLPUBLIC void osl_destroyHostAddr(oslHostAddr Addr)
Frees all resources allocated by Addr.
SAL_DLLPUBLIC oslSocketResult osl_getLocalHostname(rtl_uString **strLocalHostname)
Retrieve this machines hostname.
SAL_DLLPUBLIC oslSocketAddr osl_getSocketAddrOfHostAddr(const oslHostAddr Addr)
Get the socket address member of Addr.
SAL_DLLPUBLIC sal_Int32 osl_getServicePort(rtl_uString *strServicename, rtl_uString *strProtocol)
Looks up the port-number designated to the specified service/protocol-pair.
SAL_DLLPUBLIC oslSocketAddr osl_resolveHostname(rtl_uString *strHostname)
Uses the systems name-service interface to find an address for strHostname.
SAL_DLLPUBLIC void osl_clearSocketSet(oslSocketSet Set)
Clears the set from all previously added sockets.
SAL_DLLPUBLIC oslSocketSet osl_createSocketSet(void)
Creates a set of sockets to be used with osl_demultiplexSocketEvents().
SAL_DLLPUBLIC oslSocketResult osl_getHostnameOfSocketAddr(oslSocketAddr Addr, rtl_uString **strHostname)
Returns the hostname represented by Addr.
oslSocketMsgFlag
Represents flags to be used with send/recv-calls.
Definition: socket.h:131
@ osl_Socket_MsgDontRoute
Definition: socket.h:135
@ osl_Socket_MsgNormal
Definition: socket.h:132
@ osl_Socket_Msg_FORCE_EQUAL_SIZE
Definition: socket.h:138
@ osl_Socket_MsgInvalid
Definition: socket.h:137
@ osl_Socket_MsgMaxIOVLen
Definition: socket.h:136
@ osl_Socket_MsgPeek
Definition: socket.h:134
@ osl_Socket_MsgOOB
Definition: socket.h:133
SAL_DLLPUBLIC oslSocketAddr osl_copySocketAddr(oslSocketAddr Addr)
Creates a new SocketAddress and fills it from Addr.
SAL_DLLPUBLIC sal_Bool osl_isExceptionPending(oslSocket Socket, const TimeValue *pTimeout)
Checks if a request for out-of-band data will block.
SAL_DLLPUBLIC void osl_getLastSocketErrorDescription(oslSocket Socket, rtl_uString **strError)
returns a string which describes the last socket error.
SAL_DLLPUBLIC sal_Bool osl_isEqualSocketAddr(oslSocketAddr Addr1, oslSocketAddr Addr2)
Compares the values of two SocketAddresses.
SAL_DLLPUBLIC sal_Bool osl_shutdownSocket(oslSocket Socket, oslSocketDirection Direction)
Shuts down communication on a connected socket.
SAL_DLLPUBLIC oslAddrFamily osl_getFamilyOfSocketAddr(oslSocketAddr Addr)
Retrieves the address-family from the Addr.
Definition: time.h:66
This is the binary specification of a SAL sequence.
Definition: types.h:300