LibreOffice
LibreOffice 4.1 SDK C/C++ API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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 _OSL_SOCKET_H_
21 #define _OSL_SOCKET_H_
22 
23 #include <rtl/ustring.h>
24 #include <rtl/byteseq.h>
25 
26 #include <osl/time.h>
27 #include <rtl/tencinfo.h>
28 
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
32 
33 /* error returns */
34 #define OSL_INADDR_NONE 0xffffffff
35 #define OSL_INVALID_PORT (-1)
36 #define OSL_INVALID_IPX_SOCKET_NO 0xffffffff
37 
41 typedef struct oslSocketAddrImpl * oslSocketAddr;
42 
43 
47 typedef enum {
49  osl_Socket_FamilyIpx, /* Novell IPX/SPX */
50  osl_Socket_FamilyInvalid, /* always last entry in enum! */
53 
57 typedef enum {
58  osl_Socket_ProtocolIp, /* for all af_inet */
59  osl_Socket_ProtocolIpx, /* af_ipx datagram sockets (IPX) */
60  osl_Socket_ProtocolSpx, /* af_ipx seqpacket or stream for SPX */
61  osl_Socket_ProtocolSpxII, /* af_ipx seqpacket or stream for SPX II */
64 } oslProtocol;
65 
66 
70 typedef enum {
76  osl_Socket_TypeInvalid, /* always last entry in enum! */
79 
80 
84 typedef enum {
103  osl_Socket_OptionInvalid, /* always last entry in enum! */
106 
110 typedef enum {
113  osl_Socket_LevelInvalid, /* always last entry in enum! */
116 
117 
121 typedef enum {
127  osl_Socket_MsgInvalid, /* always last entry in enum! */
130 
134 typedef enum {
138  osl_Socket_DirInvalid, /* always last entry in enum! */
141 
144 typedef enum {
145  osl_Socket_E_None, /* no error */
146  osl_Socket_E_NotSocket, /* Socket operation on non-socket */
147  osl_Socket_E_DestAddrReq, /* Destination address required */
148  osl_Socket_E_MsgSize, /* Message too long */
149  osl_Socket_E_Prototype, /* Protocol wrong type for socket */
150  osl_Socket_E_NoProtocol, /* Protocol not available */
151  osl_Socket_E_ProtocolNoSupport, /* Protocol not supported */
152  osl_Socket_E_TypeNoSupport, /* Socket type not supported */
153  osl_Socket_E_OpNotSupport, /* Operation not supported on socket */
154  osl_Socket_E_PfNoSupport, /* Protocol family not supported */
155  osl_Socket_E_AfNoSupport, /* Address family not supported by */
156  /* protocol family */
157  osl_Socket_E_AddrInUse, /* Address already in use */
158  osl_Socket_E_AddrNotAvail, /* Can't assign requested address */
159  osl_Socket_E_NetDown, /* Network is down */
160  osl_Socket_E_NetUnreachable, /* Network is unreachable */
161  osl_Socket_E_NetReset, /* Network dropped connection because */
162  /* of reset */
163  osl_Socket_E_ConnAborted, /* Software caused connection abort */
164  osl_Socket_E_ConnReset, /* Connection reset by peer */
165  osl_Socket_E_NoBufferSpace, /* No buffer space available */
166  osl_Socket_E_IsConnected, /* Socket is already connected */
167  osl_Socket_E_NotConnected, /* Socket is not connected */
168  osl_Socket_E_Shutdown, /* Can't send after socket shutdown */
169  osl_Socket_E_TooManyRefs, /* Too many references: can't splice */
170  osl_Socket_E_TimedOut, /* Connection timed out */
171  osl_Socket_E_ConnRefused, /* Connection refused */
172  osl_Socket_E_HostDown, /* Host is down */
173  osl_Socket_E_HostUnreachable, /* No route to host */
174  osl_Socket_E_WouldBlock, /* call would block on non-blocking socket */
175  osl_Socket_E_Already, /* operation already in progress */
176  osl_Socket_E_InProgress, /* operation now in progress */
177  osl_Socket_E_InvalidError, /* unmapped error: always last entry in enum! */
180 
183 typedef enum {
184  osl_Socket_Ok, /* successful completion */
185  osl_Socket_Error, /* error occurred, check osl_getLastSocketError() for details */
186  osl_Socket_TimedOut, /* blocking operation timed out */
187  osl_Socket_Interrupted, /* blocking operation was interrupted */
188  osl_Socket_InProgress, /* nonblocking operation is in progress */
191 
194 
206 SAL_DLLPUBLIC oslSocketAddr SAL_CALL osl_createEmptySocketAddr(
207  oslAddrFamily Family);
208 
209 
212 SAL_DLLPUBLIC oslSocketAddr SAL_CALL osl_copySocketAddr(
213  oslSocketAddr Addr);
214 
220  oslSocketAddr Addr1, oslSocketAddr Addr2);
221 
227 SAL_DLLPUBLIC oslSocketAddr SAL_CALL osl_resolveHostname(
228  rtl_uString *strHostname);
229 
239 SAL_DLLPUBLIC oslSocketAddr SAL_CALL osl_createInetBroadcastAddr (
240  rtl_uString *strDottedAddr, sal_Int32 Port);
241 
242 
250 SAL_DLLPUBLIC oslSocketAddr SAL_CALL osl_createInetSocketAddr (
251  rtl_uString *strDottedAddr, sal_Int32 Port);
252 
253 
258  oslSocketAddr Addr);
259 
264 SAL_DLLPUBLIC sal_Int32 SAL_CALL osl_getServicePort(
265  rtl_uString *strServicename, rtl_uString *strProtocol);
266 
267 
268 
274  oslSocketAddr Addr);
275 
276 
281 SAL_DLLPUBLIC sal_Int32 SAL_CALL osl_getInetPortOfSocketAddr(
282  oslSocketAddr Addr);
283 
284 
291  oslSocketAddr Addr, sal_Int32 Port);
292 
293 
300  oslSocketAddr Addr, rtl_uString **strHostname);
301 
302 
312  oslSocketAddr Addr, rtl_uString **strDottedInetAddr);
313 
317  oslSocketAddr Addr, sal_Sequence *pByteSeq );
318 
326  oslSocketAddr Addr, sal_Sequence **ppByteSeq );
327 
328 /*
329  Opaque datatype HostAddr.
330 */
331 typedef struct oslHostAddrImpl * oslHostAddr;
332 
333 
339 SAL_DLLPUBLIC oslHostAddr SAL_CALL osl_createHostAddr(
340  rtl_uString *strHostname, const oslSocketAddr Addr);
341 
342 
350 SAL_DLLPUBLIC oslHostAddr SAL_CALL osl_createHostAddrByName(rtl_uString *strHostname);
351 
352 
360 SAL_DLLPUBLIC oslHostAddr SAL_CALL osl_createHostAddrByAddr(const oslSocketAddr Addr);
361 
362 
366 SAL_DLLPUBLIC oslHostAddr SAL_CALL osl_copyHostAddr(const oslHostAddr Addr);
367 
368 
372 SAL_DLLPUBLIC void SAL_CALL osl_destroyHostAddr(oslHostAddr Addr);
373 
374 
378 SAL_DLLPUBLIC void SAL_CALL osl_getHostnameOfHostAddr(const oslHostAddr Addr, rtl_uString **strHostname);
379 
380 
384 SAL_DLLPUBLIC oslSocketAddr SAL_CALL osl_getSocketAddrOfHostAddr(const oslHostAddr Addr);
385 
391 SAL_DLLPUBLIC oslSocketResult SAL_CALL osl_getLocalHostname(rtl_uString **strLocalHostname);
392 
393 
401 /*-***************************************************************************/
402 /* oslSocket */
403 /*-***************************************************************************/
404 
405 typedef struct oslSocketImpl * oslSocket;
406 
409 SAL_DLLPUBLIC void SAL_CALL osl_acquireSocket( oslSocket Socket );
410 
416 SAL_DLLPUBLIC void SAL_CALL osl_releaseSocket( oslSocket Socket );
417 
423 SAL_DLLPUBLIC oslSocket SAL_CALL osl_createSocket(
424  oslAddrFamily Family,
425  oslSocketType Type,
426  oslProtocol Protocol);
427 
434 SAL_DLLPUBLIC oslSocketAddr SAL_CALL osl_getLocalAddrOfSocket(oslSocket Socket);
435 
442 SAL_DLLPUBLIC oslSocketAddr SAL_CALL osl_getPeerAddrOfSocket(oslSocket Socket);
443 
451  oslSocket Socket,
452  oslSocketAddr Addr);
453 
466  oslSocket Socket,
467  oslSocketAddr Addr,
468  const TimeValue* pTimeout);
469 
470 
480  oslSocket Socket,
481  sal_Int32 MaxPendingConnections);
482 
483 
492  (oslSocket Socket,
493  oslSocketAddr* pAddr);
494 
515 SAL_DLLPUBLIC sal_Int32 SAL_CALL osl_receiveSocket(
516  oslSocket Socket,
517  void* pBuffer,
518  sal_uInt32 BytesToRead,
519  oslSocketMsgFlag Flag);
520 
543 SAL_DLLPUBLIC sal_Int32 SAL_CALL osl_receiveFromSocket(
544  oslSocket Socket,
545  oslSocketAddr SenderAddr,
546  void* pBuffer,
547  sal_uInt32 BufferSize,
548  oslSocketMsgFlag Flag);
549 
568 SAL_DLLPUBLIC sal_Int32 SAL_CALL osl_sendSocket(
569  oslSocket Socket,
570  const void* pBuffer,
571  sal_uInt32 BytesToSend,
572  oslSocketMsgFlag Flag);
573 
599 SAL_DLLPUBLIC sal_Int32 SAL_CALL osl_sendToSocket(
600  oslSocket Socket,
601  oslSocketAddr ReceiverAddr,
602  const void* pBuffer,
603  sal_uInt32 BytesToSend,
604  oslSocketMsgFlag Flag);
605 
618  oslSocket Socket, const TimeValue* pTimeout);
619 
631  oslSocket Socket, const TimeValue* pTimeout);
632 
643  oslSocket Socket, const TimeValue* pTimeout);
644 
656 SAL_DLLPUBLIC sal_Bool SAL_CALL osl_shutdownSocket(oslSocket Socket,
657  oslSocketDirection Direction);
658 
743 SAL_DLLPUBLIC sal_Int32 SAL_CALL osl_getSocketOption( oslSocket Socket,
744  oslSocketOptionLevel Level,
745  oslSocketOption Option,
746  void* pBuffer,
747  sal_uInt32 BufferLen);
748 
769 SAL_DLLPUBLIC sal_Bool SAL_CALL osl_setSocketOption( oslSocket Socket,
770  oslSocketOptionLevel Level,
771  oslSocketOption Option,
772  void* pBuffer,
773  sal_uInt32 BufferLen);
774 
782  oslSocket Socket, sal_Bool On);
783 
784 
790  oslSocket Socket);
791 
792 
806  oslSocket Socket);
807 
813  oslSocket Socket, rtl_uString **strError);
814 
821  oslSocket Socket);
822 
825 typedef struct oslSocketSetImpl * oslSocketSet;
826 
830 SAL_DLLPUBLIC oslSocketSet SAL_CALL osl_createSocketSet(void);
831 
834 SAL_DLLPUBLIC void SAL_CALL osl_destroySocketSet(oslSocketSet Set);
835 
839 SAL_DLLPUBLIC void SAL_CALL osl_clearSocketSet(oslSocketSet Set);
840 
841 
846 SAL_DLLPUBLIC void SAL_CALL osl_addToSocketSet(oslSocketSet Set, oslSocket Socket);
847 
852 SAL_DLLPUBLIC void SAL_CALL osl_removeFromSocketSet(oslSocketSet Set, oslSocket Socket);
853 
859 SAL_DLLPUBLIC sal_Bool SAL_CALL osl_isInSocketSet(oslSocketSet Set, oslSocket Socket);
860 
876 SAL_DLLPUBLIC sal_Int32 SAL_CALL osl_demultiplexSocketEvents(oslSocketSet IncomingSet,
877  oslSocketSet OutgoingSet,
878  oslSocketSet OutOfBandSet,
879  const TimeValue* pTimeout);
880 
884 SAL_DLLPUBLIC void SAL_CALL osl_closeSocket(oslSocket Socket);
885 
886 
896 SAL_DLLPUBLIC sal_Int32 SAL_CALL osl_readSocket( oslSocket Socket, void *pBuffer, sal_Int32 nSize );
897 
898 
907 SAL_DLLPUBLIC sal_Int32 SAL_CALL osl_writeSocket( oslSocket Socket, const void *pBuffer, sal_Int32 nSize );
908 
914 #ifdef __cplusplus
915 }
916 #endif
917 
918 #endif /* _OSL_SOCKET_H_ */
919 
920 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */