evirc: src/sock_test.h@40f7aa051acb (annotated)

40 51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	1	#ifndef SOCK_TEST_H
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	2	#define SOCK_TEST_H
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	3
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	4	/**
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	5	* @file
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	6	*
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	7	* Dummy sock_stream implemention for local testing.
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	8	*/
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	9	#include "sock_internal.h"
41 40f7aa051acb add line_proto test, enhance others Tero Marttila <terom@fixme.fi> parents: 40 diff changeset	10	#include <stdbool.h>
40 51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	11
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	12	/**
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	13	* IO vector
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	14	*/
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	15	struct io_vec {
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	16	/** The buffer */
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	17	char *buf;
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	18
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	19	/** Buffer size */
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	20	size_t len;
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	21	};
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	22
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	23	/**
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	24	* Vectored IO-buffer
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	25	*/
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	26	struct io_buf {
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	27	/** The array of buffer-vectors, {NULL}-terminated */
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	28	struct io_vec *vecs;
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	29
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	30	/** The number of io_vecs */
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	31	size_t count;
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	32
41 40f7aa051acb add line_proto test, enhance others Tero Marttila <terom@fixme.fi> parents: 40 diff changeset	33	/** Current read/write vector */
40f7aa051acb add line_proto test, enhance others Tero Marttila <terom@fixme.fi> parents: 40 diff changeset	34	struct io_vec read_vec, write_vec;
40 51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	35
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	36	/** Offset into current vector */
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	37	size_t off;
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	38	};
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	39
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	40	/**
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	41	* The per-socket state
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	42	*/
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	43	struct sock_test {
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	44	/** The base struct for sock_stream_* functions */
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	45	struct sock_stream base;
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	46
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	47	/** The send/recieve buffers */
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	48	struct io_buf send_buf, recv_buf;
41 40f7aa051acb add line_proto test, enhance others Tero Marttila <terom@fixme.fi> parents: 40 diff changeset	49
40f7aa051acb add line_proto test, enhance others Tero Marttila <terom@fixme.fi> parents: 40 diff changeset	50	/** non-blocking mode? */
40f7aa051acb add line_proto test, enhance others Tero Marttila <terom@fixme.fi> parents: 40 diff changeset	51	bool nonblocking;
40f7aa051acb add line_proto test, enhance others Tero Marttila <terom@fixme.fi> parents: 40 diff changeset	52
40f7aa051acb add line_proto test, enhance others Tero Marttila <terom@fixme.fi> parents: 40 diff changeset	53	/** No more data is going to be added, return EOF once all the rest is consumed */
40f7aa051acb add line_proto test, enhance others Tero Marttila <terom@fixme.fi> parents: 40 diff changeset	54	bool eof;
40 51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	55	};
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	56
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	57	/**
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	58	* Get a sock_stream pointer from a sock_tcp pointer
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	59	*/
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	60	#define SOCK_TEST_BASE(sock_ptr) (&(sock_ptr)->base)
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	61
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	62	/**
41 40f7aa051acb add line_proto test, enhance others Tero Marttila <terom@fixme.fi> parents: 40 diff changeset	63	* Get the sock_stream.err pointer from a sock_tcp pointer
40f7aa051acb add line_proto test, enhance others Tero Marttila <terom@fixme.fi> parents: 40 diff changeset	64	*/
40f7aa051acb add line_proto test, enhance others Tero Marttila <terom@fixme.fi> parents: 40 diff changeset	65	#define SOCK_TEST_ERR(sock_ptr) SOCK_ERR(SOCK_TEST_BASE(sock_ptr))
40f7aa051acb add line_proto test, enhance others Tero Marttila <terom@fixme.fi> parents: 40 diff changeset	66
40f7aa051acb add line_proto test, enhance others Tero Marttila <terom@fixme.fi> parents: 40 diff changeset	67	/**
40 51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	68	* A dummy stream socket intended for testing purposes.
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	69	*/
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	70	struct sock_test* sock_test_create (void);
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	71
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	72	/**
41 40f7aa051acb add line_proto test, enhance others Tero Marttila <terom@fixme.fi> parents: 40 diff changeset	73	* Destroy the sock buffer, releasing any resource we allocated ourself
40f7aa051acb add line_proto test, enhance others Tero Marttila <terom@fixme.fi> parents: 40 diff changeset	74	*/
40f7aa051acb add line_proto test, enhance others Tero Marttila <terom@fixme.fi> parents: 40 diff changeset	75	void sock_test_destroy (struct sock_test *sock);
40f7aa051acb add line_proto test, enhance others Tero Marttila <terom@fixme.fi> parents: 40 diff changeset	76
40f7aa051acb add line_proto test, enhance others Tero Marttila <terom@fixme.fi> parents: 40 diff changeset	77	/**
40 51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	78	* Set the recieve buffer contents.
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	79	*
41 40f7aa051acb add line_proto test, enhance others Tero Marttila <terom@fixme.fi> parents: 40 diff changeset	80	* The vectors themselves are copied, but the data they contain is not.
40f7aa051acb add line_proto test, enhance others Tero Marttila <terom@fixme.fi> parents: 40 diff changeset	81	*
40f7aa051acb add line_proto test, enhance others Tero Marttila <terom@fixme.fi> parents: 40 diff changeset	82	* If the EOF flag is given, it indicates that no more data will be added, otherwise the eof status is unchanged.
40 51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	83	*/
41 40f7aa051acb add line_proto test, enhance others Tero Marttila <terom@fixme.fi> parents: 40 diff changeset	84	void sock_test_set_recv_buffer (struct sock_test sock, struct io_vec vecs, size_t count, bool eof);
40f7aa051acb add line_proto test, enhance others Tero Marttila <terom@fixme.fi> parents: 40 diff changeset	85
40f7aa051acb add line_proto test, enhance others Tero Marttila <terom@fixme.fi> parents: 40 diff changeset	86	/**
40f7aa051acb add line_proto test, enhance others Tero Marttila <terom@fixme.fi> parents: 40 diff changeset	87	* Add some data to the recieve buffer
40f7aa051acb add line_proto test, enhance others Tero Marttila <terom@fixme.fi> parents: 40 diff changeset	88	*/
40f7aa051acb add line_proto test, enhance others Tero Marttila <terom@fixme.fi> parents: 40 diff changeset	89	void sock_test_add_recv_vec (struct sock_test *sock, struct io_vec vec);
40 51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	90
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	91	/**
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	92	* Get the send buffer contents as a single string, free() after use if you care about that
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	93	*/
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	94	void sock_test_get_send_data (struct sock_test sock, char buf, size_t len);
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	95
51678c7eae03 add sock_test module and some basic initial tests Tero Marttila <terom@fixme.fi> parents: diff changeset	96	#endif

author	Tero Marttila <terom@fixme.fi>
	Thu, 12 Mar 2009 21:12:48 +0200
changeset 41	40f7aa051acb
parent 40	51678c7eae03
child 42	13cfc41f76a7
permissions	-rw-r--r--