socket_common.h

Go to the documentation of this file.

#ifndef SOCKET_COMMON_H
#define SOCKET_COMMON_H
 
#include "low_level_platform.h"

#define DELAY_BETWEEN_SOCKET_RETRIES MSEC(100)

#define TCP_TIMEOUT_TIME SEC(10)

#define UDP_TIMEOUT_TIME SEC(1)

#define CONNECT_RETRY_INTERVAL MSEC(500)

#define CONNECT_TIMEOUT MINUTES(1)

#define MAX_NUM_PORT_ADDRESSES 16u

#define PORT_BIND_RETRY_INTERVAL SEC(1)

#define PORT_BIND_RETRY_LIMIT 60

#define DEFAULT_PORT 15045u

#define MSG_TYPE_FAILED 25
 
typedef enum socket_type_t { TCP, UDP } socket_type_t;

int create_real_time_tcp_socket_errexit();

int create_server(uint16_t port, int* final_socket, uint16_t* final_port, socket_type_t sock_type,
                  bool increment_port_on_retry);

 
int accept_socket(int socket, int rti_socket);

int connect_to_socket(int sock, const char* hostname, int port);

int read_from_socket(int socket, size_t num_bytes, unsigned char* buffer);

int read_from_socket_close_on_error(int* socket, size_t num_bytes, unsigned char* buffer);

void read_from_socket_fail_on_error(int* socket, size_t num_bytes, unsigned char* buffer, lf_mutex_t* mutex,
                                    char* format, ...);

ssize_t peek_from_socket(int socket, unsigned char* result);

int write_to_socket(int socket, size_t num_bytes, unsigned char* buffer);

int write_to_socket_close_on_error(int* socket, size_t num_bytes, unsigned char* buffer);

void write_to_socket_fail_on_error(int* socket, size_t num_bytes, unsigned char* buffer, lf_mutex_t* mutex,
                                   char* format, ...);

void init_shutdown_mutex(void);

int shutdown_socket(int* socket, bool read_before_closing);
 
#endif /* SOCKET_COMMON_H */