1

#ifndef SOCK_TCP_H

     2

#define SOCK_TCP_H

     3

     4

/**

     5

 * @file

     6

 *

     7

 * TCP implementation of sock_stream interface.

     8

 */

     9

#include "sock_internal.h"

    10

#include "sock_fd.h"

    11

#include <netdb.h>

    12

    13

/**

    14

 * Contains the base sock_stream struct, and the file descriptor

    15

 */

    16

struct sock_tcp {

    17

    /** The base struct for sock_stream_* functions */

    18

    struct sock_fd base_fd;

    19

    20

    /** The current connect_async resolved address */

    21

    struct addrinfo *async_res, *async_cur;

    22

};

    23

    24

/**

    25

 * Get a sock_fd pointer from a sock_tcp pointer

    26

 */

    27

#define SOCK_TCP_FD(sock_ptr) (&(sock_ptr)->base_fd)

    28

    29

/**

    30

 * Get a sock_base pointer from a sock_tcp pointer

    31

 */

    32

#define SOCK_TCP_BASE(sock_ptr) SOCK_FD_BASE(SOCK_TCP_FD(sock_ptr))

    33

    34

/**

    35

 * Get the sock_stream.err pointer from a sock_tcp pointer

    36

 */

    37

#define SOCK_TCP_ERR(sock_ptr) SOCK_ERR(SOCK_TCP_BASE(sock_ptr))

    38

    39

/**

    40

 * Initialize a blank sock_tcp by creating a new socket (using the socket() syscall), but doesn't do anything further.

    41

 *

    42

 * This uses the ai_family, ai_socktype and ai_protocol fields from the given addrinfo.

    43

 */

    44

err_t sock_tcp_init_socket (struct sock_tcp *sock, struct addrinfo *addr, struct error_info *err);

    45

    46

/**

    47

 * Initiate an async connection operation on the given socket to the given address. Once the connect() completes,

    48

 * either the on_connect or the on_error callback will be called.

    49

 *

    50

 * If, for some weird reason, this ends up doing a blocking connect(), the on_connect callback will be called directly.

    51

 * If the async connect fails, this just returns the error.

    52

 *

    53

 * @param sock the unconnected TCP sockect to connect with

    54

 * @param addr the address to connect to

    55

 * @param err returned error info

    56

 */

    57

err_t sock_tcp_connect_async_addr (struct sock_tcp *sock, struct addrinfo *addr, struct error_info *err);

    58

    59

/**

    60

 * Attempt to connect asyncronously to the given hostname/service. Once a connection has been established, the

    61

 * on_connect() callback will be called.

    62

 *

    63

 * In case of errors, either on_error() will be called, or an error returned - depending on when the error happaned.

    64

 *

    65

 * @param sock the unconnected TCP socket to connect with

    66

 * @param hostname the hostname to resolve

    67

 * @param service the service to connect to

    68

 * @param err returned error info

    69

 */

    70

err_t sock_tcp_connect_async_begin (struct sock_tcp *sock, const char *hostname, const char *service, struct error_info *err);

    71

    72

/**

    73

 * Initialize a blank sock_tcp by connecting in a blocking fashion.

    74

 */

    75

err_t sock_tcp_connect_blocking (struct sock_tcp *sock, const char *hostname, const char *service, struct error_info *err);

    76

    77

/**

    78

 * Free a non-connected sock_tcp

    79

 */

    80

void sock_tcp_free (struct sock_tcp *sock);

    81

    82

#endif /* SOCK_TCP_H */