vl_socket.h

Go to the documentation of this file.

 
#ifndef VL_SOCKET_H
#define VL_SOCKET_H
 
#include <vl/vl_memory.h>
#include <vl/vl_numtypes.h>
 
#ifndef VL_SOCKET_NULL
#define VL_SOCKET_NULL ((vl_socket)0)
#endif
 
typedef struct vl_socket_* vl_socket;
 
typedef enum vl_socket_domain_
{
    VL_SOCKET_DOMAIN_IPV4 = 0,
    VL_SOCKET_DOMAIN_IPV6 = 1
} vl_socket_domain;
 
typedef enum vl_socket_type_
{
    VL_SOCKET_TYPE_STREAM = 0,
    VL_SOCKET_TYPE_DATAGRAM = 1
} vl_socket_type;
 
typedef enum vl_socket_shutdown_
{
    VL_SOCKET_SHUTDOWN_RECEIVE = 0,
    VL_SOCKET_SHUTDOWN_SEND = 1,
    VL_SOCKET_SHUTDOWN_BOTH = 2
} vl_socket_shutdown;
 
typedef enum vl_socket_result_
{
    VL_SOCKET_SUCCESS = 0,
 
    VL_SOCKET_ERROR_INVALID_ARGUMENT,
    VL_SOCKET_ERROR_NOT_INITIALIZED,
    VL_SOCKET_ERROR_ALLOCATION,
 
    VL_SOCKET_ERROR_CREATE,
    VL_SOCKET_ERROR_BIND,
    VL_SOCKET_ERROR_LISTEN,
    VL_SOCKET_ERROR_ACCEPT,
    VL_SOCKET_ERROR_CONNECT,
    VL_SOCKET_ERROR_SEND,
    VL_SOCKET_ERROR_RECEIVE,
    VL_SOCKET_ERROR_SHUTDOWN,
    VL_SOCKET_ERROR_CLOSE,
    VL_SOCKET_ERROR_SET_OPTION,
 
    VL_SOCKET_ERROR_WOULD_BLOCK,
    VL_SOCKET_ERROR_NOT_CONNECTED,
    VL_SOCKET_ERROR_ADDRESS_FAMILY,
    VL_SOCKET_ERROR_SYSTEM
} vl_socket_result;
 
typedef struct vl_socket_address_
{
    vl_socket_domain domain;
    vl_uint16_t port;
 
    union
    {
        vl_uint8_t ipv4[4];
        vl_uint8_t ipv6[16];
    } host;
} vl_socket_address;
 
VL_API vl_socket_result vlSocketStartup(void);
 
VL_API void vlSocketShutdownLibrary(void);
 
VL_API vl_socket vlSocketNew(vl_socket_domain domain, vl_socket_type type);
 
VL_API void vlSocketDelete(vl_socket socket);
 
VL_API vl_socket_result vlSocketBind(vl_socket socket, const vl_socket_address* address);
 
VL_API vl_socket_result vlSocketListen(vl_socket socket, vl_int_t backlog);
 
VL_API vl_socket vlSocketAccept(vl_socket socket, vl_socket_address* outAddress);
 
VL_API vl_socket_result vlSocketConnect(vl_socket socket, const vl_socket_address* address);
 
VL_API vl_int64_t vlSocketSend(vl_socket socket, const void* buffer, vl_memsize_t length);
 
VL_API vl_int64_t vlSocketReceive(vl_socket socket, void* buffer, vl_memsize_t length);
 
VL_API vl_socket_result vlSocketShutdown(vl_socket socket, vl_socket_shutdown how);
 
VL_API vl_socket_result vlSocketSetBlocking(vl_socket socket, vl_bool_t blocking);
 
VL_API vl_bool_t vlSocketAddressSetIPv4(vl_socket_address* address, vl_uint8_t a, vl_uint8_t b, vl_uint8_t c,
                                        vl_uint8_t d, vl_uint16_t port);
 
VL_API vl_bool_t vlSocketAddressSetIPv6(vl_socket_address* address, const vl_uint8_t ipv6Bytes[16], vl_uint16_t port);
 
VL_API vl_socket_result vlSocketSetReuseAddress(vl_socket socket, vl_bool_t enabled);
 
VL_API vl_socket_result vlSocketSetNoDelay(vl_socket socket, vl_bool_t enabled);
 
VL_API vl_socket_result vlSocketSetKeepAlive(vl_socket socket, vl_bool_t enabled);
 
VL_API vl_socket_result vlSocketGetReuseAddress(vl_socket socket, vl_bool_t* outEnabled);
 
VL_API vl_socket_result vlSocketGetNoDelay(vl_socket socket, vl_bool_t* outEnabled);
 
VL_API vl_socket_result vlSocketGetKeepAlive(vl_socket socket, vl_bool_t* outEnabled);
 
VL_API vl_socket_result vlSocketIsBlocking(vl_socket socket, vl_bool_t* outBlocking);
 
VL_API vl_socket_result vlSocketGetRemoteAddress(vl_socket socket, vl_socket_address* outAddress);
 
VL_API vl_bool_t vlSocketAddressToString(const vl_socket_address* address, char* buffer, vl_memsize_t bufferSize);
 
VL_API vl_bool_t vlSocketAddressFromString(vl_socket_address* address, const char* string);
 
VL_API const char* vlSocketError(void);
 
VL_API vl_socket_result vlSocketGetLocalAddress(vl_socket socket, vl_socket_address* outAddress);
 
#endif // VL_SOCKET_H