urg_tcpclient.h

Go to the documentation of this file.

#ifndef URG_TCPCLIENT_H
#define URG_TCPCLIENT_H

#ifdef __cplusplus
extern "C" {
#endif

#include "urg_ring_buffer.h"
#include "urg_detect_os.h"
#include <sys/types.h>
#if defined(URG_WINDOWS_OS)
#include <windows.h>
#else
#include <sys/socket.h>
#include <netinet/in.h>
#include <arpa/inet.h>
#endif


// -- NOT INTERFACE, for internal use only --
// For urg_ringbuffer.h
// The size of buffer must be specified by the power of 2
// i.e. ring buffer size = two to the RB_BITSHIFT-th power.
enum {
    RB_BITSHIFT = 8,
    RB_SIZE = 1 << RB_BITSHIFT,

    // caution ! available buffer size is less than the
    // size given to the ring buffer(RB_SIZE).
    BUFSIZE = RB_SIZE - 1,
};


typedef struct {
    // socket
    struct sockaddr_in server_addr;
    int sock_desc;
    int sock_addr_size;

    // buffer
    ring_buffer_t rb;
    char buf[RB_SIZE];

    // line reading functions
    int pushed_back; // for pushded back char

} urg_tcpclient_t;
// -- end of NON INTERFACE definitions --


// -- belows are MODULE INTERFACES --
extern int tcpclient_open(urg_tcpclient_t* cli,
                          const char* server_ip_str, int port_num);


extern void tcpclient_close(urg_tcpclient_t* cli);


extern int tcpclient_read(urg_tcpclient_t* cli,
                          char* userbuf, int req_size, int timeout);


extern int tcpclient_write(urg_tcpclient_t* cli,
                           const char* userbuf, int req_size);


extern int tcpclient_error(urg_tcpclient_t* cli,
                           char* error_message, int max_size);


extern int tcpclient_readline(urg_tcpclient_t* cli,
                              char* userbuf, int buf_size, int timeout);

#ifdef __cplusplus
}
#endif

#endif /* !URG_TCPCLIENT_H */