socket.h

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

/*
 * This file is part of LibreOffice published API.
 */

#ifndef INCLUDED_OSL_SOCKET_H
#define INCLUDED_OSL_SOCKET_H

#include "rtl/ustring.h"
#include "osl/time.h"

#ifdef __cplusplus
extern "C" {
#endif

/* error returns */
#define OSL_INADDR_NONE             0xffffffff
#define OSL_INVALID_PORT (-1)

typedef struct oslSocketAddrImpl * oslSocketAddr;

typedef enum {
    osl_Socket_FamilyInet,          
    osl_Socket_FamilyIpx,           
    osl_Socket_FamilyInvalid,       
    osl_Socket_Family_FORCE_EQUAL_SIZE = SAL_MAX_ENUM
} oslAddrFamily;

typedef enum {
    osl_Socket_ProtocolIp,          
    osl_Socket_ProtocolIpx,         
    osl_Socket_ProtocolSpx,         
    osl_Socket_ProtocolSpxII,       
    osl_Socket_ProtocolInvalid,     
    osl_Socket_Protocol_FORCE_EQUAL_SIZE = SAL_MAX_ENUM
} oslProtocol;

typedef enum {
    osl_Socket_TypeStream,          
    osl_Socket_TypeDgram,           
    osl_Socket_TypeRaw,             
    osl_Socket_TypeRdm,             
    osl_Socket_TypeSeqPacket,       
    osl_Socket_TypeInvalid,         
    osl_Socket_Type_FORCE_EQUAL_SIZE = SAL_MAX_ENUM
} oslSocketType;


typedef enum {
    osl_Socket_OptionDebug,         
    osl_Socket_OptionAcceptConn,    
    osl_Socket_OptionReuseAddr,     
    osl_Socket_OptionKeepAlive,     
    osl_Socket_OptionDontRoute,     
    osl_Socket_OptionBroadcast,     
    osl_Socket_OptionUseLoopback,   
    osl_Socket_OptionLinger,        
    osl_Socket_OptionOOBinLine,     
    osl_Socket_OptionSndBuf,        
    osl_Socket_OptionRcvBuf,        
    osl_Socket_OptionSndLowat,      
    osl_Socket_OptionRcvLowat,      
    osl_Socket_OptionSndTimeo,      
    osl_Socket_OptionRcvTimeo,      
    osl_Socket_OptionError,         
    osl_Socket_OptionType,          
    osl_Socket_OptionTcpNoDelay,    
    osl_Socket_OptionInvalid,       
    osl_Socket_Option_FORCE_EQUAL_SIZE = SAL_MAX_ENUM
} oslSocketOption;

typedef enum  {
    osl_Socket_LevelSocket,
    osl_Socket_LevelTcp,
    osl_Socket_LevelInvalid,        
    osl_Socket_Level_FORCE_EQUAL_SIZE = SAL_MAX_ENUM
} oslSocketOptionLevel;

typedef enum {
    osl_Socket_MsgNormal,
    osl_Socket_MsgOOB,
    osl_Socket_MsgPeek,
    osl_Socket_MsgDontRoute,
    osl_Socket_MsgMaxIOVLen,
    osl_Socket_MsgInvalid,          
    osl_Socket_Msg_FORCE_EQUAL_SIZE = SAL_MAX_ENUM
} oslSocketMsgFlag;

typedef enum {
    osl_Socket_DirRead,
    osl_Socket_DirWrite,
    osl_Socket_DirReadWrite,
    osl_Socket_DirInvalid,          
    osl_Socket_Dir_FORCE_EQUAL_SIZE = SAL_MAX_ENUM
} oslSocketDirection;

typedef enum {
    osl_Socket_E_None,              
    osl_Socket_E_NotSocket,         
    osl_Socket_E_DestAddrReq,       
    osl_Socket_E_MsgSize,           
    osl_Socket_E_Prototype,         
    osl_Socket_E_NoProtocol,        
    osl_Socket_E_ProtocolNoSupport, 
    osl_Socket_E_TypeNoSupport,     
    osl_Socket_E_OpNotSupport,      
    osl_Socket_E_PfNoSupport,       
    osl_Socket_E_AfNoSupport,       
    osl_Socket_E_AddrInUse,         
    osl_Socket_E_AddrNotAvail,      
    osl_Socket_E_NetDown,           
    osl_Socket_E_NetUnreachable,    
    osl_Socket_E_NetReset,          
    osl_Socket_E_ConnAborted,       
    osl_Socket_E_ConnReset,         
    osl_Socket_E_NoBufferSpace,     
    osl_Socket_E_IsConnected,       
    osl_Socket_E_NotConnected,      
    osl_Socket_E_Shutdown,          
    osl_Socket_E_TooManyRefs,       
    osl_Socket_E_TimedOut,          
    osl_Socket_E_ConnRefused,       
    osl_Socket_E_HostDown,          
    osl_Socket_E_HostUnreachable,   
    osl_Socket_E_WouldBlock,        
    osl_Socket_E_Already,           
    osl_Socket_E_InProgress,        
    osl_Socket_E_InvalidError,      
    osl_Socket_E_FORCE_EQUAL_SIZE = SAL_MAX_ENUM
} oslSocketError;

typedef enum {
    osl_Socket_Ok,                  
    osl_Socket_Error,               
    osl_Socket_TimedOut,            
    osl_Socket_Interrupted,         
    osl_Socket_InProgress,          
    osl_Socket_FORCE_EQUAL_SIZE = SAL_MAX_ENUM
} oslSocketResult;

typedef sal_uInt8 oslSocketIpxNetNumber[4];
typedef sal_uInt8 oslSocketIpxNodeNumber[6];

typedef struct oslSocketImpl * oslSocket;

SAL_DLLPUBLIC oslSocket SAL_CALL osl_createSocket(
                            oslAddrFamily Family,
                            oslSocketType Type,
                            oslProtocol Protocol);

SAL_DLLPUBLIC void SAL_CALL osl_acquireSocket(oslSocket Socket);

SAL_DLLPUBLIC void SAL_CALL osl_releaseSocket(oslSocket Socket);

SAL_DLLPUBLIC oslSocketAddr SAL_CALL osl_getLocalAddrOfSocket(oslSocket Socket);

SAL_DLLPUBLIC oslSocketAddr SAL_CALL osl_getPeerAddrOfSocket(oslSocket Socket);

SAL_DLLPUBLIC sal_Bool SAL_CALL osl_bindAddrToSocket(
                           oslSocket Socket,
                           oslSocketAddr Addr);

SAL_DLLPUBLIC oslSocketResult SAL_CALL osl_connectSocketTo(
                              oslSocket Socket,
                              oslSocketAddr Addr,
                              const TimeValue* pTimeout);


SAL_DLLPUBLIC sal_Bool SAL_CALL osl_listenOnSocket(
                            oslSocket Socket,
                            sal_Int32 MaxPendingConnections);


SAL_DLLPUBLIC oslSocket SAL_CALL osl_acceptConnectionOnSocket(
                            oslSocket Socket,
                            oslSocketAddr* pAddr);

SAL_DLLPUBLIC sal_Int32 SAL_CALL osl_receiveSocket(
                            oslSocket Socket,
                            void* pBuffer,
                            sal_uInt32 BytesToRead,
                            oslSocketMsgFlag Flag);

SAL_DLLPUBLIC sal_Int32 SAL_CALL osl_receiveFromSocket(
                            oslSocket Socket,
                            oslSocketAddr SenderAddr,
                            void* pBuffer,
                            sal_uInt32 BufferSize,
                            oslSocketMsgFlag Flag);

SAL_DLLPUBLIC sal_Int32 SAL_CALL osl_sendSocket(
                            oslSocket Socket,
                            const void* pBuffer,
                            sal_uInt32 BytesToSend,
                            oslSocketMsgFlag Flag);

SAL_DLLPUBLIC sal_Int32 SAL_CALL osl_sendToSocket(
                            oslSocket Socket,
                            oslSocketAddr ReceiverAddr,
                            const void* pBuffer,
                            sal_uInt32 BytesToSend,
                            oslSocketMsgFlag Flag);

SAL_DLLPUBLIC sal_Bool SAL_CALL osl_isReceiveReady(
                            oslSocket Socket,
                            const TimeValue* pTimeout);

SAL_DLLPUBLIC sal_Bool SAL_CALL osl_isSendReady(
                            oslSocket Socket,
                            const TimeValue* pTimeout);

SAL_DLLPUBLIC sal_Bool SAL_CALL osl_isExceptionPending(
                            oslSocket Socket,
                            const TimeValue* pTimeout);

SAL_DLLPUBLIC sal_Bool SAL_CALL osl_shutdownSocket(
                            oslSocket Socket,
                            oslSocketDirection Direction);

SAL_DLLPUBLIC sal_Int32 SAL_CALL osl_getSocketOption(
                            oslSocket Socket,
                            oslSocketOptionLevel Level,
                            oslSocketOption Option,
                            void* pBuffer,
                            sal_uInt32 BufferLen);

SAL_DLLPUBLIC sal_Bool SAL_CALL osl_setSocketOption(
                            oslSocket Socket,
                            oslSocketOptionLevel Level,
                            oslSocketOption Option,
                            void* pBuffer,
                            sal_uInt32 BufferLen);

SAL_DLLPUBLIC sal_Bool SAL_CALL osl_enableNonBlockingMode(
                            oslSocket Socket,
                            sal_Bool On);


SAL_DLLPUBLIC sal_Bool SAL_CALL osl_isNonBlockingMode(oslSocket Socket);

SAL_DLLPUBLIC oslSocketType SAL_CALL osl_getSocketType(oslSocket Socket);

SAL_DLLPUBLIC void SAL_CALL osl_getLastSocketErrorDescription(
                            oslSocket Socket,
                            rtl_uString **strError);

SAL_DLLPUBLIC oslSocketError SAL_CALL osl_getLastSocketError(
                            oslSocket Socket);

SAL_DLLPUBLIC void SAL_CALL osl_closeSocket(oslSocket Socket);


SAL_DLLPUBLIC sal_Int32 SAL_CALL osl_readSocket(
                            oslSocket Socket,
                            void *pBuffer,
                            sal_Int32 nSize);


SAL_DLLPUBLIC sal_Int32 SAL_CALL osl_writeSocket(
                            oslSocket Socket,
                            const void *pBuffer,
                            sal_Int32 nSize);

SAL_DLLPUBLIC oslSocketAddr SAL_CALL osl_createEmptySocketAddr(
        oslAddrFamily Family);


SAL_DLLPUBLIC oslSocketAddr SAL_CALL osl_copySocketAddr(
        oslSocketAddr Addr);

SAL_DLLPUBLIC sal_Bool SAL_CALL osl_isEqualSocketAddr(
    oslSocketAddr Addr1, oslSocketAddr Addr2);

SAL_DLLPUBLIC oslSocketAddr SAL_CALL osl_resolveHostname(
        rtl_uString *strHostname);

SAL_DLLPUBLIC oslSocketAddr SAL_CALL osl_createInetBroadcastAddr(
    rtl_uString *strDottedAddr, sal_Int32 Port);


SAL_DLLPUBLIC oslSocketAddr SAL_CALL osl_createInetSocketAddr (
    rtl_uString *strDottedAddr, sal_Int32 Port);


SAL_DLLPUBLIC void SAL_CALL osl_destroySocketAddr(
        oslSocketAddr Addr);

SAL_DLLPUBLIC sal_Int32 SAL_CALL osl_getServicePort(
        rtl_uString *strServicename, rtl_uString *strProtocol);



SAL_DLLPUBLIC oslAddrFamily SAL_CALL osl_getFamilyOfSocketAddr(
        oslSocketAddr Addr);


SAL_DLLPUBLIC sal_Int32 SAL_CALL osl_getInetPortOfSocketAddr(
        oslSocketAddr Addr);


SAL_DLLPUBLIC sal_Bool SAL_CALL osl_setInetPortOfSocketAddr(
        oslSocketAddr Addr, sal_Int32 Port);


SAL_DLLPUBLIC oslSocketResult SAL_CALL osl_getHostnameOfSocketAddr(
        oslSocketAddr Addr, rtl_uString **strHostname);


SAL_DLLPUBLIC oslSocketResult SAL_CALL osl_getDottedInetAddrOfSocketAddr(
        oslSocketAddr Addr, rtl_uString **strDottedInetAddr);

SAL_DLLPUBLIC oslSocketResult SAL_CALL osl_setAddrOfSocketAddr(
        oslSocketAddr Addr, sal_Sequence *pByteSeq );

SAL_DLLPUBLIC oslSocketResult SAL_CALL osl_getAddrOfSocketAddr(
        oslSocketAddr Addr, sal_Sequence **ppByteSeq );

/*
    Opaque datatype HostAddr.
*/
typedef struct oslHostAddrImpl * oslHostAddr;


SAL_DLLPUBLIC oslHostAddr SAL_CALL osl_createHostAddr(
        rtl_uString *strHostname, const oslSocketAddr Addr);


SAL_DLLPUBLIC oslHostAddr SAL_CALL osl_createHostAddrByName(rtl_uString *strHostname);


SAL_DLLPUBLIC oslHostAddr SAL_CALL osl_createHostAddrByAddr(const oslSocketAddr Addr);


SAL_DLLPUBLIC oslHostAddr SAL_CALL osl_copyHostAddr(const oslHostAddr Addr);


SAL_DLLPUBLIC void SAL_CALL osl_destroyHostAddr(oslHostAddr Addr);


SAL_DLLPUBLIC void SAL_CALL osl_getHostnameOfHostAddr(const oslHostAddr Addr, rtl_uString **strHostname);


SAL_DLLPUBLIC oslSocketAddr SAL_CALL osl_getSocketAddrOfHostAddr(const oslHostAddr Addr);

SAL_DLLPUBLIC oslSocketResult SAL_CALL osl_getLocalHostname(rtl_uString **strLocalHostname);


#ifdef __cplusplus
}
#endif

#endif // INCLUDED_OSL_SOCKET_H

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */