csock.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2020-2022 Intel Corporation
 */
 
#ifndef _CSOCK_H_
#define _CSOCK_H_
 
#include <stdint.h>           // for uint32_t
#include <stddef.h>           // for size_t
#include <sys/types.h>        // for ssize_t
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define CSOCK_API __attribute__((visibility("default")))
 
#define __csock_unused __attribute__((__unused__))
 
enum {
    CSOCK_MAX_HOST_NAME_LENGTH = 128,  
    CSOCK_MAX_SOCK_INFO_LENGTH = 1024, 
    DEFAULT_CSOCK_RX_LEN       = 4096, 
    DEFAULT_CSOCK_TX_LEN       = 4096, 
    CSOCK_IS_SERVER    = (1 << 0), 
    CSOCK_IS_CLIENT    = (1 << 1), 
    CSOCK_NON_BLOCKING = (1 << 2), 
    CSOCK_GROUP_WRITE  = (1 << 3), 
    CSOCK_EOF          = (1 << 4), 
    CSOCK_STDIO_TYPE   = (1 << 5), 
};
 
typedef void csock_t; 
typedef void *(csock_client_fn_t)(csock_t *c);
 
typedef ssize_t(csock_write_t)(csock_t *c, char *data, size_t len);
 
typedef ssize_t(csock_read_t)(csock_t *c, char *data, size_t len);
 
typedef int(csock_close_t)(csock_t *c);
 
typedef struct csock_cfg {
    uint32_t flags;  
    char *host_addr; 
    csock_client_fn_t *client_fn; 
    csock_read_t *read_fn;        
    csock_write_t *write_fn;      
    csock_close_t *close_fn;      
} csock_cfg_t;
 
CSOCK_API csock_t *csock_create(csock_cfg_t *cfg);
 
CSOCK_API void csock_destroy(csock_t *c);
 
CSOCK_API int csock_server_start(csock_t *c);
 
CSOCK_API csock_t *csock_accept(csock_t *s);
 
CSOCK_API ssize_t csock_read(csock_t *c, char *data, size_t len);
 
CSOCK_API ssize_t csock_write(csock_t *c, char *data, size_t len);
 
CSOCK_API int csock_close(csock_t *c);
 
CSOCK_API struct sockaddr *csock_get_peer(csock_t *c);
 
CSOCK_API int csock_eof(csock_t *_c);
 
CSOCK_API int csock_get_fd(csock_t *c);
 
CSOCK_API int csock_set_fd(csock_t *_c, int fd);
 
CSOCK_API int csock_is_closed(csock_t *c);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _CSOCK_H_ */