src/sock_tcp.h
author Tero Marttila <terom@fixme.fi>
Sun, 22 Feb 2009 10:16:28 +0200
changeset 10 9fe218576d13
parent 3 cc94ae754e2a
child 11 14e79683c48c
permissions -rw-r--r--
fix sock_stream read/write return value, move line buffer inside of line_proto, add some initial code for event-based non-blocking operation
#ifndef SOCK_TCP_H
#define SOCK_TCP_H

/*
 * TCP implementation of sock_stream interface.
 */
#include "sock_internal.h"

/*
 * Contains the base sock_stream struct, and the file descriptor
 */
struct sock_tcp {
    /* The base struct for sock_stream_* functions */
    struct sock_stream base;
    
    /* The OS file descriptor */
    int fd;

    /* The libevent struct */
    struct event *ev;
};

#define SOCK_TCP_BASE(sock_ptr) (&(sock_ptr)->base)
#define SOCK_TCP_ERR(sock_ptr) SOCK_ERR(SOCK_TCP_BASE(sock_ptr))

/*
 * Allocate a new blank sock_tcp with a correctly initialized base
 */
err_t sock_tcp_alloc (struct sock_tcp **sock_ptr);

/*
 * Initialize a blank sock_tcp with a given already-existing fd
 */
err_t sock_tcp_init_fd (struct sock_tcp *sock, int fd);

/*
 * Initialize sock_tcp.ev to use the socket's fd with the given callback. By default, this is created with EV_READ
 * flags, but is not added.
 */
err_t sock_tcp_init_ev (struct sock_tcp *sock, void (*ev_cb) (evutil_socket_t, short, void *), void *arg);

/*
 * Initialize a blank sock_tcp by connecting
 */
err_t sock_tcp_init_connect (struct sock_tcp *sock, const char *hostname, const char *service);

/*
 * Set the socket's nonblock mode
 */
err_t sock_tcp_set_nonblock (struct sock_tcp *sock, int nonblock);

/*
 * Release a non-connected sock_tcp
 */
void sock_tcp_release (struct sock_tcp *sock);

#endif /* SOCK_TCP_H */