evirc: src/sock.h@9fe218576d13 (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_H
cf0e1bb6bcab a fancy socket abstraction layer, with TCP, next, SSL. Also, .hgignore Tero Marttila <terom@fixme.fi> parents: diff changeset	2	#define SOCK_H
cf0e1bb6bcab a fancy socket abstraction layer, with TCP, next, SSL. Also, .hgignore Tero Marttila <terom@fixme.fi> parents: diff changeset	3
cf0e1bb6bcab a fancy socket abstraction layer, with TCP, next, SSL. Also, .hgignore Tero Marttila <terom@fixme.fi> parents: diff changeset	4	/*
cf0e1bb6bcab a fancy socket abstraction layer, with TCP, next, SSL. Also, .hgignore Tero Marttila <terom@fixme.fi> parents: diff changeset	5	* Low-level socket-related functions
cf0e1bb6bcab a fancy socket abstraction layer, with TCP, next, SSL. Also, .hgignore Tero Marttila <terom@fixme.fi> parents: diff changeset	6	*/
3 cc94ae754e2a error handling magic Tero Marttila <terom@fixme.fi> parents: 2 diff changeset	7	#include "error.h"
1 cf0e1bb6bcab a fancy socket abstraction layer, with TCP, next, SSL. Also, .hgignore Tero Marttila <terom@fixme.fi> parents: diff changeset	8	#include <sys/types.h>
9 4c4c906cc649 add sock_stream_callbacks and ev_base Tero Marttila <terom@fixme.fi> parents: 8 diff changeset	9	#include <event2/event.h>
1 cf0e1bb6bcab a fancy socket abstraction layer, with TCP, next, SSL. Also, .hgignore Tero Marttila <terom@fixme.fi> parents: diff changeset	10
cf0e1bb6bcab a fancy socket abstraction layer, with TCP, next, SSL. Also, .hgignore Tero Marttila <terom@fixme.fi> parents: diff changeset	11	/*
cf0e1bb6bcab a fancy socket abstraction layer, with TCP, next, SSL. Also, .hgignore Tero Marttila <terom@fixme.fi> parents: diff changeset	12	* The generic socket handle
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_stream;
cf0e1bb6bcab a fancy socket abstraction layer, with TCP, next, SSL. Also, .hgignore Tero Marttila <terom@fixme.fi> parents: diff changeset	15
cf0e1bb6bcab a fancy socket abstraction layer, with TCP, next, SSL. Also, .hgignore Tero Marttila <terom@fixme.fi> parents: diff changeset	16	/*
9 4c4c906cc649 add sock_stream_callbacks and ev_base Tero Marttila <terom@fixme.fi> parents: 8 diff changeset	17	* Async callbacks for socket operation
4c4c906cc649 add sock_stream_callbacks and ev_base Tero Marttila <terom@fixme.fi> parents: 8 diff changeset	18	*/
4c4c906cc649 add sock_stream_callbacks and ev_base Tero Marttila <terom@fixme.fi> parents: 8 diff changeset	19	struct sock_stream_callbacks {
4c4c906cc649 add sock_stream_callbacks and ev_base Tero Marttila <terom@fixme.fi> parents: 8 diff changeset	20	/* Sockeet is readable */
4c4c906cc649 add sock_stream_callbacks and ev_base Tero Marttila <terom@fixme.fi> parents: 8 diff changeset	21	void (on_read)(struct sock_stream sock, void *arg);
4c4c906cc649 add sock_stream_callbacks and ev_base Tero Marttila <terom@fixme.fi> parents: 8 diff changeset	22
4c4c906cc649 add sock_stream_callbacks and ev_base Tero Marttila <terom@fixme.fi> parents: 8 diff changeset	23	/* Socket is writeable */
4c4c906cc649 add sock_stream_callbacks and ev_base Tero Marttila <terom@fixme.fi> parents: 8 diff changeset	24	void (on_write)(struct sock_stream sock, void *arg);
4c4c906cc649 add sock_stream_callbacks and ev_base Tero Marttila <terom@fixme.fi> parents: 8 diff changeset	25	};
4c4c906cc649 add sock_stream_callbacks and ev_base Tero Marttila <terom@fixme.fi> parents: 8 diff changeset	26
4c4c906cc649 add sock_stream_callbacks and ev_base Tero Marttila <terom@fixme.fi> parents: 8 diff changeset	27	/*
3 cc94ae754e2a error handling magic Tero Marttila <terom@fixme.fi> parents: 2 diff changeset	28	* Initialize the socket module's global state. Call this before calling any other sock_* functions.
9 4c4c906cc649 add sock_stream_callbacks and ev_base Tero Marttila <terom@fixme.fi> parents: 8 diff changeset	29	*
4c4c906cc649 add sock_stream_callbacks and ev_base Tero Marttila <terom@fixme.fi> parents: 8 diff changeset	30	* The given \a ev_base is the libevent base to use for nonblocking operation.
3 cc94ae754e2a error handling magic Tero Marttila <terom@fixme.fi> parents: 2 diff changeset	31	*/
9 4c4c906cc649 add sock_stream_callbacks and ev_base Tero Marttila <terom@fixme.fi> parents: 8 diff changeset	32	err_t sock_init (struct event_base ev_base, struct error_info err);
3 cc94ae754e2a error handling magic Tero Marttila <terom@fixme.fi> parents: 2 diff changeset	33
cc94ae754e2a error handling magic Tero Marttila <terom@fixme.fi> parents: 2 diff changeset	34	/*
cc94ae754e2a error handling magic Tero Marttila <terom@fixme.fi> parents: 2 diff changeset	35	* A simple blocking TCP connect to the given host/service, using getaddrinfo. The connected socket is returned via
5 a09a0797f6f0 ERROR-ify sock_gnutls Tero Marttila <terom@fixme.fi> parents: 4 diff changeset	36	* sock_ptr. In case of errors, additional error information is stored in err.
3 cc94ae754e2a error handling magic Tero Marttila <terom@fixme.fi> parents: 2 diff changeset	37	*
cc94ae754e2a error handling magic Tero Marttila <terom@fixme.fi> parents: 2 diff changeset	38	* @return zero on success, nonzero on error
1 cf0e1bb6bcab a fancy socket abstraction layer, with TCP, next, SSL. Also, .hgignore Tero Marttila <terom@fixme.fi> parents: diff changeset	39	*
cf0e1bb6bcab a fancy socket abstraction layer, with TCP, next, SSL. Also, .hgignore Tero Marttila <terom@fixme.fi> parents: diff changeset	40	* XXX: blocking
cf0e1bb6bcab a fancy socket abstraction layer, with TCP, next, SSL. Also, .hgignore Tero Marttila <terom@fixme.fi> parents: diff changeset	41	*/
3 cc94ae754e2a error handling magic Tero Marttila <terom@fixme.fi> parents: 2 diff changeset	42	err_t sock_tcp_connect (struct sock_stream *sock_ptr, const char host, const char service, struct error_info err);
1 cf0e1bb6bcab a fancy socket abstraction layer, with TCP, next, SSL. Also, .hgignore Tero Marttila <terom@fixme.fi> parents: diff changeset	43
cf0e1bb6bcab a fancy socket abstraction layer, with TCP, next, SSL. Also, .hgignore Tero Marttila <terom@fixme.fi> parents: diff changeset	44	/*
5 a09a0797f6f0 ERROR-ify sock_gnutls Tero Marttila <terom@fixme.fi> parents: 4 diff changeset	45	* A simple blocking SSL connect to the given host/service. The connected/handshake'd SSL socket is returned via
a09a0797f6f0 ERROR-ify sock_gnutls Tero Marttila <terom@fixme.fi> parents: 4 diff changeset	46	* sock_ptr. In case of errors, additional error information is stored in err.
1 cf0e1bb6bcab a fancy socket abstraction layer, with TCP, next, SSL. Also, .hgignore Tero Marttila <terom@fixme.fi> parents: diff changeset	47	*
cf0e1bb6bcab a fancy socket abstraction layer, with TCP, next, SSL. Also, .hgignore Tero Marttila <terom@fixme.fi> parents: diff changeset	48	* XXX: blocking
cf0e1bb6bcab a fancy socket abstraction layer, with TCP, next, SSL. Also, .hgignore Tero Marttila <terom@fixme.fi> parents: diff changeset	49	* XXX: doesn't do any certificate verification.
cf0e1bb6bcab a fancy socket abstraction layer, with TCP, next, SSL. Also, .hgignore Tero Marttila <terom@fixme.fi> parents: diff changeset	50	*/
5 a09a0797f6f0 ERROR-ify sock_gnutls Tero Marttila <terom@fixme.fi> parents: 4 diff changeset	51	err_t sock_gnutls_connect (struct sock_stream *sock_ptr, const char host, const char service, struct error_info err);
1 cf0e1bb6bcab a fancy socket abstraction layer, with TCP, next, SSL. Also, .hgignore Tero Marttila <terom@fixme.fi> parents: diff changeset	52
cf0e1bb6bcab a fancy socket abstraction layer, with TCP, next, SSL. Also, .hgignore Tero Marttila <terom@fixme.fi> parents: diff changeset	53	/*
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: 9 diff changeset	54	* The generic read/write API for stream sockets.
9 4c4c906cc649 add sock_stream_callbacks and ev_base Tero Marttila <terom@fixme.fi> parents: 8 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: 9 diff changeset	56	int sock_stream_read (struct sock_stream sock, void buf, size_t len);
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: 9 diff changeset	57	int sock_stream_write (struct sock_stream sock, const void buf, size_t len);
9 4c4c906cc649 add sock_stream_callbacks and ev_base Tero Marttila <terom@fixme.fi> parents: 8 diff changeset	58
4c4c906cc649 add sock_stream_callbacks and ev_base Tero Marttila <terom@fixme.fi> parents: 8 diff changeset	59	/*
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: 9 diff changeset	60	* Initialize event-based operation for this sock_stream. This will set the stream into nonblocking mode, and the given
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: 9 diff changeset	61	* callbacks will be fired once enabled using sock_stream_event_enable().
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: 9 diff changeset	62	*
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: 9 diff changeset	63	* Note that the callbacks struct isn't copied - it's used as-is-given.
1 cf0e1bb6bcab a fancy socket abstraction layer, with TCP, next, SSL. Also, .hgignore Tero Marttila <terom@fixme.fi> parents: diff changeset	64	*/
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: 9 diff changeset	65	err_t sock_stream_event_init (struct sock_stream sock, const struct sock_stream_callbacks callbacks, 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: 9 diff changeset	66
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: 9 diff changeset	67	/*
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: 9 diff changeset	68	* Prime the callbacks set up earlier with sock_stream_event_init to fire once ready.
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: 9 diff changeset	69	*
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: 9 diff changeset	70	* \a mask is a bitmask of EV_* bits, such as EV_READ, EV_WRITE or EV_PERSIST. See event_set() for more info about the
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: 9 diff changeset	71	* behaviour of those.
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: 9 diff changeset	72	*/
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: 9 diff changeset	73	err_t sock_stream_event_enable (struct sock_stream *sock, short mask);
3 cc94ae754e2a error handling magic Tero Marttila <terom@fixme.fi> parents: 2 diff changeset	74
cc94ae754e2a error handling magic Tero Marttila <terom@fixme.fi> parents: 2 diff changeset	75	/**
8 be88e543c8ff split off line_proto, and make sock_stream_error return a const error_info Tero Marttila <terom@fixme.fi> parents: 5 diff changeset	76	* Get current error_info for \a sock.
3 cc94ae754e2a error handling magic Tero Marttila <terom@fixme.fi> parents: 2 diff changeset	77	*/
8 be88e543c8ff split off line_proto, and make sock_stream_error return a const error_info Tero Marttila <terom@fixme.fi> parents: 5 diff changeset	78	const struct error_info* sock_stream_error (struct sock_stream *sock);
1 cf0e1bb6bcab a fancy socket abstraction layer, with TCP, next, SSL. Also, .hgignore Tero Marttila <terom@fixme.fi> parents: diff changeset	79
cf0e1bb6bcab a fancy socket abstraction layer, with TCP, next, SSL. Also, .hgignore Tero Marttila <terom@fixme.fi> parents: diff changeset	80	#endif

author	Tero Marttila <terom@fixme.fi>
	Sun, 22 Feb 2009 10:16:28 +0200
changeset 10	9fe218576d13
parent 9	4c4c906cc649
child 12	4147fae232d9
permissions	-rw-r--r--