sopc_raw_sockets.h

Go to the documentation of this file.

/*
 * Licensed to Systerel under one or more contributor license
 * agreements. See the NOTICE file distributed with this work
 * for additional information regarding copyright ownership.
 * Systerel 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
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
 
#ifndef SOPC_RAW_SOCKETS_H_
#define SOPC_RAW_SOCKETS_H_
 
#include <stdbool.h>
#include <stdint.h>
#include "sopc_enums.h"
 
typedef struct SOPC_Socket_Impl SOPC_Socket_Impl;
typedef SOPC_Socket_Impl* SOPC_Socket;
#define SOPC_INVALID_SOCKET NULL
 
typedef struct SOPC_Socket_AddressInfo SOPC_Socket_AddressInfo;
 
typedef struct SOPC_Socket_Address SOPC_Socket_Address;
 
typedef struct SOPC_SocketSet SOPC_SocketSet;
 
SOPC_ReturnStatus SOPC_Socket_Network_Enable_Keepalive(SOPC_Socket sock,
                                                       unsigned int firstProbeDelay,
                                                       unsigned int interval,
                                                       unsigned int counter);
 
SOPC_ReturnStatus SOPC_Socket_Network_Disable_Keepalive(SOPC_Socket sock);
 
bool SOPC_Socket_Network_Initialize(void);
 
bool SOPC_Socket_Network_Clear(void);
 
SOPC_ReturnStatus SOPC_Socket_AddrInfo_Get(const char* hostname, const char* port, SOPC_Socket_AddressInfo** addrs);
 
SOPC_Socket_AddressInfo* SOPC_Socket_AddrInfo_IterNext(SOPC_Socket_AddressInfo* addr);
 
uint8_t SOPC_Socket_AddrInfo_IsIPV6(const SOPC_Socket_AddressInfo* addr);
 
void SOPC_Socket_AddrInfoDelete(SOPC_Socket_AddressInfo** addrs);
 
SOPC_Socket_Address* SOPC_Socket_GetPeerAddress(SOPC_Socket sock);
 
SOPC_Socket_Address* SOPC_Socket_CopyAddress(SOPC_Socket_AddressInfo* addr);
 
SOPC_ReturnStatus SOPC_SocketAddress_GetNameInfo(const SOPC_Socket_Address* addr, char** host, char** service);
 
void SOPC_SocketAddress_Delete(SOPC_Socket_Address** addr);
 
void SOPC_Socket_Clear(SOPC_Socket* sock);
 
SOPC_ReturnStatus SOPC_Socket_CreateNew(SOPC_Socket_AddressInfo* addr,
                                        bool setReuseAddr,
                                        bool setNonBlocking,
                                        SOPC_Socket* sock);
 
SOPC_ReturnStatus SOPC_Socket_Listen(SOPC_Socket sock, SOPC_Socket_AddressInfo* addr);
 
SOPC_ReturnStatus SOPC_Socket_Accept(SOPC_Socket listeningSock, bool setNonBlocking, SOPC_Socket* acceptedSock);
 
SOPC_ReturnStatus SOPC_Socket_Connect(SOPC_Socket sock, SOPC_Socket_AddressInfo* addr);
 
SOPC_ReturnStatus SOPC_Socket_ConnectToLocal(SOPC_Socket from, SOPC_Socket to);
 
SOPC_ReturnStatus SOPC_Socket_CheckAckConnect(SOPC_Socket sock);
 
SOPC_SocketSet* SOPC_SocketSet_Create(void);
 
void SOPC_SocketSet_Delete(SOPC_SocketSet** set);
 
void SOPC_SocketSet_Add(SOPC_Socket sock, SOPC_SocketSet* sockSet);
 
bool SOPC_SocketSet_IsPresent(SOPC_Socket sock, SOPC_SocketSet* sockSet);
void SOPC_SocketSet_Clear(SOPC_SocketSet* sockSet);
 
int32_t SOPC_Socket_WaitSocketEvents(SOPC_SocketSet* readSet,
                                     SOPC_SocketSet* writeSet,
                                     SOPC_SocketSet* exceptSet,
                                     uint32_t waitMs);
 
SOPC_ReturnStatus SOPC_Socket_Write(SOPC_Socket sock, const uint8_t* data, uint32_t count, uint32_t* sentBytes);
 
SOPC_ReturnStatus SOPC_Socket_Read(SOPC_Socket sock, uint8_t* data, uint32_t dataSize, uint32_t* readCount);
 
SOPC_ReturnStatus SOPC_Socket_BytesToRead(SOPC_Socket sock, uint32_t* bytesToRead);
 
void SOPC_Socket_Close(SOPC_Socket* sock);
 
#endif /* SOPC_RAW_SOCKETS_H_ */