hal_socket.h

Go to the documentation of this file.

/*
 *  socket_hal.h
 *
 *  Copyright 2013-2021 Michael Zillgith
 *
 *  This file is part of Platform Abstraction Layer (libpal)
 *  for libiec61850, libmms, and lib60870.
 */
 
#ifndef SOCKET_HAL_H_
#define SOCKET_HAL_H_
 
#include "hal_base.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct sServerSocket* ServerSocket;
 
typedef struct sUdpSocket* UdpSocket;
 
typedef struct sSocket* Socket;
 
typedef struct sHandleSet* HandleSet;
 
typedef enum
{
    SOCKET_STATE_CONNECTING = 0,
    SOCKET_STATE_FAILED = 1,
    SOCKET_STATE_CONNECTED = 2
} SocketState;
 
 
PAL_API HandleSet
Handleset_new(void);
 
PAL_API void
Handleset_reset(HandleSet self);
 
PAL_API void
Handleset_addSocket(HandleSet self, const Socket sock);
 
void
Handleset_removeSocket(HandleSet self, const Socket sock);
 
PAL_API int
Handleset_waitReady(HandleSet self, unsigned int timeoutMs);
 
PAL_API void
Handleset_destroy(HandleSet self);
 
PAL_API ServerSocket
TcpServerSocket_create(const char* address, int port);
 
PAL_API UdpSocket
UdpSocket_create(void);
 
PAL_API bool
UdpSocket_bind(UdpSocket self, const char* address, int port);
 
PAL_API bool
UdpSocket_sendTo(UdpSocket self, const char* address, int port, uint8_t* msg, int msgSize);
 
PAL_API int
UdpSocket_receiveFrom(UdpSocket self, char* address, int maxAddrSize, uint8_t* msg, int msgSize);
 
 
PAL_API void
ServerSocket_listen(ServerSocket self);
 
PAL_API Socket
ServerSocket_accept(ServerSocket self);
 
PAL_API void
Socket_activateTcpKeepAlive(Socket self, int idleTime, int interval, int count);
 
PAL_API void
ServerSocket_setBacklog(ServerSocket self, int backlog);
 
PAL_API void
ServerSocket_destroy(ServerSocket self);
 
PAL_API Socket
TcpSocket_create(void);
 
PAL_API void
Socket_setConnectTimeout(Socket self, uint32_t timeoutInMs);
 
PAL_API bool
Socket_bind(Socket self, const char* srcAddress, int srcPort);
 
PAL_API bool
Socket_connect(Socket self, const char* address, int port);
 
PAL_API bool
Socket_connectAsync(Socket self, const char* address, int port);
 
PAL_API SocketState
Socket_checkAsyncConnectState(Socket self);
 
PAL_API int
Socket_read(Socket self, uint8_t* buf, int size);
 
PAL_API int
Socket_write(Socket self, uint8_t* buf, int size);
 
PAL_API char*
Socket_getLocalAddress(Socket self);
 
PAL_API char*
Socket_getPeerAddress(Socket self);
 
PAL_API char*
Socket_getPeerAddressStatic(Socket self, char* peerAddressString);
 
PAL_API void
Socket_destroy(Socket self);
 
#ifdef __cplusplus
}
#endif
 
#endif /* SOCKET_HAL_H_ */