evirc: src/sock_tcp.h@9c1050bc8709 (annotated)

1 cf0e1bb6bcab a fancy socket abstraction layer, with TCP, next, SSL. Also, .hgignore Tero Marttila <terom@fixme.fi> parents: diff changeset	1	#ifndef SOCK_TCP_H
cf0e1bb6bcab a fancy socket abstraction layer, with TCP, next, SSL. Also, .hgignore Tero Marttila <terom@fixme.fi> parents: diff changeset	2	#define SOCK_TCP_H
cf0e1bb6bcab a fancy socket abstraction layer, with TCP, next, SSL. Also, .hgignore Tero Marttila <terom@fixme.fi> parents: diff changeset	3
28 9c1050bc8709 add sock_stream_release/line_proto_release/irc_conn_release functions, and add proper cleanup to irc_net_create Tero Marttila <terom@fixme.fi> parents: 12 diff changeset	4	/**
9c1050bc8709 add sock_stream_release/line_proto_release/irc_conn_release functions, and add proper cleanup to irc_net_create Tero Marttila <terom@fixme.fi> parents: 12 diff changeset	5	* @file
9c1050bc8709 add sock_stream_release/line_proto_release/irc_conn_release functions, and add proper cleanup to irc_net_create Tero Marttila <terom@fixme.fi> parents: 12 diff changeset	6	*
1 cf0e1bb6bcab a fancy socket abstraction layer, with TCP, next, SSL. Also, .hgignore Tero Marttila <terom@fixme.fi> parents: diff changeset	7	* TCP implementation of sock_stream interface.
cf0e1bb6bcab a fancy socket abstraction layer, with TCP, next, SSL. Also, .hgignore Tero Marttila <terom@fixme.fi> parents: diff changeset	8	*/
cf0e1bb6bcab a fancy socket abstraction layer, with TCP, next, SSL. Also, .hgignore Tero Marttila <terom@fixme.fi> parents: diff changeset	9	#include "sock_internal.h"
cf0e1bb6bcab a fancy socket abstraction layer, with TCP, next, SSL. Also, .hgignore Tero Marttila <terom@fixme.fi> parents: diff changeset	10
28 9c1050bc8709 add sock_stream_release/line_proto_release/irc_conn_release functions, and add proper cleanup to irc_net_create Tero Marttila <terom@fixme.fi> parents: 12 diff changeset	11	/**
1 cf0e1bb6bcab a fancy socket abstraction layer, with TCP, next, SSL. Also, .hgignore Tero Marttila <terom@fixme.fi> parents: diff changeset	12	* Contains the base sock_stream struct, and the file descriptor
cf0e1bb6bcab a fancy socket abstraction layer, with TCP, next, SSL. Also, .hgignore Tero Marttila <terom@fixme.fi> parents: diff changeset	13	*/
cf0e1bb6bcab a fancy socket abstraction layer, with TCP, next, SSL. Also, .hgignore Tero Marttila <terom@fixme.fi> parents: diff changeset	14	struct sock_tcp {
cf0e1bb6bcab a fancy socket abstraction layer, with TCP, next, SSL. Also, .hgignore Tero Marttila <terom@fixme.fi> parents: diff changeset	15	/* The base struct for sock_stream_* functions */
cf0e1bb6bcab a fancy socket abstraction layer, with TCP, next, SSL. Also, .hgignore Tero Marttila <terom@fixme.fi> parents: diff changeset	16	struct sock_stream base;
cf0e1bb6bcab a fancy socket abstraction layer, with TCP, next, SSL. Also, .hgignore Tero Marttila <terom@fixme.fi> parents: diff changeset	17
cf0e1bb6bcab a fancy socket abstraction layer, with TCP, next, SSL. Also, .hgignore Tero Marttila <terom@fixme.fi> parents: diff changeset	18	/* The OS file descriptor */
cf0e1bb6bcab a fancy socket abstraction layer, with TCP, next, SSL. Also, .hgignore Tero Marttila <terom@fixme.fi> parents: diff changeset	19	int fd;
10 9fe218576d13 fix sock_stream read/write return value, move line buffer inside of line_proto, add some initial code for event-based non-blocking operation Tero Marttila <terom@fixme.fi> parents: 3 diff changeset	20
11 14e79683c48c working event-based operation for sock_tcp Tero Marttila <terom@fixme.fi> parents: 10 diff changeset	21	/* The IO events */
14e79683c48c working event-based operation for sock_tcp Tero Marttila <terom@fixme.fi> parents: 10 diff changeset	22	struct event ev_read, ev_write;
1 cf0e1bb6bcab a fancy socket abstraction layer, with TCP, next, SSL. Also, .hgignore Tero Marttila <terom@fixme.fi> parents: diff changeset	23	};
cf0e1bb6bcab a fancy socket abstraction layer, with TCP, next, SSL. Also, .hgignore Tero Marttila <terom@fixme.fi> parents: diff changeset	24
28 9c1050bc8709 add sock_stream_release/line_proto_release/irc_conn_release functions, and add proper cleanup to irc_net_create Tero Marttila <terom@fixme.fi> parents: 12 diff changeset	25	/**
9c1050bc8709 add sock_stream_release/line_proto_release/irc_conn_release functions, and add proper cleanup to irc_net_create Tero Marttila <terom@fixme.fi> parents: 12 diff changeset	26	* Get a sock_stream pointer from a sock_tcp pointer
9c1050bc8709 add sock_stream_release/line_proto_release/irc_conn_release functions, and add proper cleanup to irc_net_create Tero Marttila <terom@fixme.fi> parents: 12 diff changeset	27	*/
1 cf0e1bb6bcab a fancy socket abstraction layer, with TCP, next, SSL. Also, .hgignore Tero Marttila <terom@fixme.fi> parents: diff changeset	28	#define SOCK_TCP_BASE(sock_ptr) (&(sock_ptr)->base)
28 9c1050bc8709 add sock_stream_release/line_proto_release/irc_conn_release functions, and add proper cleanup to irc_net_create Tero Marttila <terom@fixme.fi> parents: 12 diff changeset	29
9c1050bc8709 add sock_stream_release/line_proto_release/irc_conn_release functions, and add proper cleanup to irc_net_create Tero Marttila <terom@fixme.fi> parents: 12 diff changeset	30	/**
9c1050bc8709 add sock_stream_release/line_proto_release/irc_conn_release functions, and add proper cleanup to irc_net_create Tero Marttila <terom@fixme.fi> parents: 12 diff changeset	31	* Get the sock_stream.err pointer from a sock_tcp pointer
9c1050bc8709 add sock_stream_release/line_proto_release/irc_conn_release functions, and add proper cleanup to irc_net_create Tero Marttila <terom@fixme.fi> parents: 12 diff changeset	32	*/
3 cc94ae754e2a error handling magic Tero Marttila <terom@fixme.fi> parents: 2 diff changeset	33	#define SOCK_TCP_ERR(sock_ptr) SOCK_ERR(SOCK_TCP_BASE(sock_ptr))
1 cf0e1bb6bcab a fancy socket abstraction layer, with TCP, next, SSL. Also, .hgignore Tero Marttila <terom@fixme.fi> parents: diff changeset	34
28 9c1050bc8709 add sock_stream_release/line_proto_release/irc_conn_release functions, and add proper cleanup to irc_net_create Tero Marttila <terom@fixme.fi> parents: 12 diff changeset	35	/**
2 a834f0559939 working SSL using gnutls - a bit of a painful process Tero Marttila <terom@fixme.fi> parents: 1 diff changeset	36	* Allocate a new blank sock_tcp with a correctly initialized base
1 cf0e1bb6bcab a fancy socket abstraction layer, with TCP, next, SSL. Also, .hgignore Tero Marttila <terom@fixme.fi> parents: diff changeset	37	*/
3 cc94ae754e2a error handling magic Tero Marttila <terom@fixme.fi> parents: 2 diff changeset	38	err_t sock_tcp_alloc (struct sock_tcp **sock_ptr);
2 a834f0559939 working SSL using gnutls - a bit of a painful process Tero Marttila <terom@fixme.fi> parents: 1 diff changeset	39
28 9c1050bc8709 add sock_stream_release/line_proto_release/irc_conn_release functions, and add proper cleanup to irc_net_create Tero Marttila <terom@fixme.fi> parents: 12 diff changeset	40	/**
2 a834f0559939 working SSL using gnutls - a bit of a painful process Tero Marttila <terom@fixme.fi> parents: 1 diff changeset	41	* Initialize a blank sock_tcp with a given already-existing fd
a834f0559939 working SSL using gnutls - a bit of a painful process Tero Marttila <terom@fixme.fi> parents: 1 diff changeset	42	*/
3 cc94ae754e2a error handling magic Tero Marttila <terom@fixme.fi> parents: 2 diff changeset	43	err_t sock_tcp_init_fd (struct sock_tcp *sock, int fd);
2 a834f0559939 working SSL using gnutls - a bit of a painful process Tero Marttila <terom@fixme.fi> parents: 1 diff changeset	44
28 9c1050bc8709 add sock_stream_release/line_proto_release/irc_conn_release functions, and add proper cleanup to irc_net_create Tero Marttila <terom@fixme.fi> parents: 12 diff changeset	45	/**
11 14e79683c48c working event-based operation for sock_tcp Tero Marttila <terom@fixme.fi> parents: 10 diff changeset	46	* Initialize sock_tcp.ev_* to use the socket's fd with the given callback. The ev's are not activated yet.
10 9fe218576d13 fix sock_stream read/write return value, move line buffer inside of line_proto, add some initial code for event-based non-blocking operation Tero Marttila <terom@fixme.fi> parents: 3 diff changeset	47	*/
9fe218576d13 fix sock_stream read/write return value, move line buffer inside of line_proto, add some initial code for event-based non-blocking operation Tero Marttila <terom@fixme.fi> parents: 3 diff changeset	48	err_t sock_tcp_init_ev (struct sock_tcp sock, void (ev_cb) (evutil_socket_t, short, void ), void arg);
9fe218576d13 fix sock_stream read/write return value, move line buffer inside of line_proto, add some initial code for event-based non-blocking operation Tero Marttila <terom@fixme.fi> parents: 3 diff changeset	49
28 9c1050bc8709 add sock_stream_release/line_proto_release/irc_conn_release functions, and add proper cleanup to irc_net_create Tero Marttila <terom@fixme.fi> parents: 12 diff changeset	50	/**
2 a834f0559939 working SSL using gnutls - a bit of a painful process Tero Marttila <terom@fixme.fi> parents: 1 diff changeset	51	* Initialize a blank sock_tcp by connecting
a834f0559939 working SSL using gnutls - a bit of a painful process Tero Marttila <terom@fixme.fi> parents: 1 diff changeset	52	*/
3 cc94ae754e2a error handling magic Tero Marttila <terom@fixme.fi> parents: 2 diff changeset	53	err_t sock_tcp_init_connect (struct sock_tcp sock, const char hostname, const char *service);
cc94ae754e2a error handling magic Tero Marttila <terom@fixme.fi> parents: 2 diff changeset	54
28 9c1050bc8709 add sock_stream_release/line_proto_release/irc_conn_release functions, and add proper cleanup to irc_net_create Tero Marttila <terom@fixme.fi> parents: 12 diff changeset	55	/**
10 9fe218576d13 fix sock_stream read/write return value, move line buffer inside of line_proto, add some initial code for event-based non-blocking operation Tero Marttila <terom@fixme.fi> parents: 3 diff changeset	56	* Set the socket's nonblock mode
9fe218576d13 fix sock_stream read/write return value, move line buffer inside of line_proto, add some initial code for event-based non-blocking operation Tero Marttila <terom@fixme.fi> parents: 3 diff changeset	57	*/
9fe218576d13 fix sock_stream read/write return value, move line buffer inside of line_proto, add some initial code for event-based non-blocking operation Tero Marttila <terom@fixme.fi> parents: 3 diff changeset	58	err_t sock_tcp_set_nonblock (struct sock_tcp *sock, int nonblock);
9fe218576d13 fix sock_stream read/write return value, move line buffer inside of line_proto, add some initial code for event-based non-blocking operation Tero Marttila <terom@fixme.fi> parents: 3 diff changeset	59
28 9c1050bc8709 add sock_stream_release/line_proto_release/irc_conn_release functions, and add proper cleanup to irc_net_create Tero Marttila <terom@fixme.fi> parents: 12 diff changeset	60	/**
12 4147fae232d9 update sock_stream_read/write semantics for EOF/EAGAIN, tentative event-based gnutls code Tero Marttila <terom@fixme.fi> parents: 11 diff changeset	61	* event_add the specified ev_* events.
4147fae232d9 update sock_stream_read/write semantics for EOF/EAGAIN, tentative event-based gnutls code Tero Marttila <terom@fixme.fi> parents: 11 diff changeset	62	*/
4147fae232d9 update sock_stream_read/write semantics for EOF/EAGAIN, tentative event-based gnutls code Tero Marttila <terom@fixme.fi> parents: 11 diff changeset	63	err_t sock_tcp_add_event (struct sock_tcp *sock, short mask);
4147fae232d9 update sock_stream_read/write semantics for EOF/EAGAIN, tentative event-based gnutls code Tero Marttila <terom@fixme.fi> parents: 11 diff changeset	64
28 9c1050bc8709 add sock_stream_release/line_proto_release/irc_conn_release functions, and add proper cleanup to irc_net_create Tero Marttila <terom@fixme.fi> parents: 12 diff changeset	65	/**
9c1050bc8709 add sock_stream_release/line_proto_release/irc_conn_release functions, and add proper cleanup to irc_net_create Tero Marttila <terom@fixme.fi> parents: 12 diff changeset	66	* Close a connected sock_tcp
3 cc94ae754e2a error handling magic Tero Marttila <terom@fixme.fi> parents: 2 diff changeset	67	*/
28 9c1050bc8709 add sock_stream_release/line_proto_release/irc_conn_release functions, and add proper cleanup to irc_net_create Tero Marttila <terom@fixme.fi> parents: 12 diff changeset	68	void sock_tcp_close (struct sock_tcp *sock);
9c1050bc8709 add sock_stream_release/line_proto_release/irc_conn_release functions, and add proper cleanup to irc_net_create Tero Marttila <terom@fixme.fi> parents: 12 diff changeset	69
9c1050bc8709 add sock_stream_release/line_proto_release/irc_conn_release functions, and add proper cleanup to irc_net_create Tero Marttila <terom@fixme.fi> parents: 12 diff changeset	70	/**
9c1050bc8709 add sock_stream_release/line_proto_release/irc_conn_release functions, and add proper cleanup to irc_net_create Tero Marttila <terom@fixme.fi> parents: 12 diff changeset	71	* Free a non-connected sock_tcp
9c1050bc8709 add sock_stream_release/line_proto_release/irc_conn_release functions, and add proper cleanup to irc_net_create Tero Marttila <terom@fixme.fi> parents: 12 diff changeset	72	*/
9c1050bc8709 add sock_stream_release/line_proto_release/irc_conn_release functions, and add proper cleanup to irc_net_create Tero Marttila <terom@fixme.fi> parents: 12 diff changeset	73	void sock_tcp_free (struct sock_tcp *sock);
1 cf0e1bb6bcab a fancy socket abstraction layer, with TCP, next, SSL. Also, .hgignore Tero Marttila <terom@fixme.fi> parents: diff changeset	74
cf0e1bb6bcab a fancy socket abstraction layer, with TCP, next, SSL. Also, .hgignore Tero Marttila <terom@fixme.fi> parents: diff changeset	75	#endif /* SOCK_TCP_H */

author	Tero Marttila <terom@fixme.fi>
	Tue, 10 Mar 2009 02:34:11 +0200
changeset 28	9c1050bc8709
parent 12	4147fae232d9
child 29	3f0f2898fea3
permissions	-rw-r--r--