evirc: src/irc_client.h@f357f835f0d5 (annotated)

53 12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	1	#ifndef IRC_CLIENT_H
12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	2	#define IRC_CLIENT_H
12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	3
12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	4	/**
12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	5	* @file
12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	6	*
12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	7	* Defines the high-level, full-featured IRC 'client' state, which essentially manipulates a set of irc_net's
12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	8	*/
12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	9	#include "irc_net.h"
12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	10	#include <sys/queue.h>
12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	11
12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	12	/**
98 f357f835f0d5 add irc_client_defaults to apply default values for irc_client_add_net irc_net_info, implement --defaults cmd opt and lua_client_connect Tero Marttila <terom@fixme.fi> parents: 87 diff changeset	13	* Defaults for irc_client operation, mostly add_net
f357f835f0d5 add irc_client_defaults to apply default values for irc_client_add_net irc_net_info, implement --defaults cmd opt and lua_client_connect Tero Marttila <terom@fixme.fi> parents: 87 diff changeset	14	*/
f357f835f0d5 add irc_client_defaults to apply default values for irc_client_add_net irc_net_info, implement --defaults cmd opt and lua_client_connect Tero Marttila <terom@fixme.fi> parents: 87 diff changeset	15	struct irc_client_defaults {
f357f835f0d5 add irc_client_defaults to apply default values for irc_client_add_net irc_net_info, implement --defaults cmd opt and lua_client_connect Tero Marttila <terom@fixme.fi> parents: 87 diff changeset	16	/** Default nickname/username/etc to use */
f357f835f0d5 add irc_client_defaults to apply default values for irc_client_add_net irc_net_info, implement --defaults cmd opt and lua_client_connect Tero Marttila <terom@fixme.fi> parents: 87 diff changeset	17	struct irc_conn_register_info register_info;
f357f835f0d5 add irc_client_defaults to apply default values for irc_client_add_net irc_net_info, implement --defaults cmd opt and lua_client_connect Tero Marttila <terom@fixme.fi> parents: 87 diff changeset	18
f357f835f0d5 add irc_client_defaults to apply default values for irc_client_add_net irc_net_info, implement --defaults cmd opt and lua_client_connect Tero Marttila <terom@fixme.fi> parents: 87 diff changeset	19	/** Default service (port) to use for non-SSL connections */
f357f835f0d5 add irc_client_defaults to apply default values for irc_client_add_net irc_net_info, implement --defaults cmd opt and lua_client_connect Tero Marttila <terom@fixme.fi> parents: 87 diff changeset	20	const char *service;
f357f835f0d5 add irc_client_defaults to apply default values for irc_client_add_net irc_net_info, implement --defaults cmd opt and lua_client_connect Tero Marttila <terom@fixme.fi> parents: 87 diff changeset	21
f357f835f0d5 add irc_client_defaults to apply default values for irc_client_add_net irc_net_info, implement --defaults cmd opt and lua_client_connect Tero Marttila <terom@fixme.fi> parents: 87 diff changeset	22	/** Default service (port) to use for SSL connections */
f357f835f0d5 add irc_client_defaults to apply default values for irc_client_add_net irc_net_info, implement --defaults cmd opt and lua_client_connect Tero Marttila <terom@fixme.fi> parents: 87 diff changeset	23	const char *service_ssl;
f357f835f0d5 add irc_client_defaults to apply default values for irc_client_add_net irc_net_info, implement --defaults cmd opt and lua_client_connect Tero Marttila <terom@fixme.fi> parents: 87 diff changeset	24	};
f357f835f0d5 add irc_client_defaults to apply default values for irc_client_add_net irc_net_info, implement --defaults cmd opt and lua_client_connect Tero Marttila <terom@fixme.fi> parents: 87 diff changeset	25
f357f835f0d5 add irc_client_defaults to apply default values for irc_client_add_net irc_net_info, implement --defaults cmd opt and lua_client_connect Tero Marttila <terom@fixme.fi> parents: 87 diff changeset	26	/**
87 f0db6ebf18b9 documentation tweaks Tero Marttila <terom@fixme.fi> parents: 63 diff changeset	27	* High-level IRC client state, this just means a set of named irc_net's and some common behaviour.
53 12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	28	*/
12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	29	struct irc_client {
98 f357f835f0d5 add irc_client_defaults to apply default values for irc_client_add_net irc_net_info, implement --defaults cmd opt and lua_client_connect Tero Marttila <terom@fixme.fi> parents: 87 diff changeset	30	/** Default parameters */
f357f835f0d5 add irc_client_defaults to apply default values for irc_client_add_net irc_net_info, implement --defaults cmd opt and lua_client_connect Tero Marttila <terom@fixme.fi> parents: 87 diff changeset	31	struct irc_client_defaults defaults;
f357f835f0d5 add irc_client_defaults to apply default values for irc_client_add_net irc_net_info, implement --defaults cmd opt and lua_client_connect Tero Marttila <terom@fixme.fi> parents: 87 diff changeset	32
53 12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	33	/** Our set of configured IRC networks */
12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	34	TAILQ_HEAD(irc_client_networks, irc_net) networks;
12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	35
12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	36	/** Are we in the process of quitting all networks? */
12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	37	bool quitting;
12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	38
12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	39	/** Have we quit all networks? */
12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	40	bool quit;
12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	41	};
12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	42
12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	43	/**
12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	44	* Construct a new irc_client
12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	45	*/
12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	46	err_t irc_client_create (struct irc_client *client_ptr, struct error_info err);
12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	47
12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	48	/**
12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	49	* Destroy the irc_client, also destroying all networks
12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	50	*/
12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	51	void irc_client_destroy (struct irc_client *client);
12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	52
12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	53	/**
98 f357f835f0d5 add irc_client_defaults to apply default values for irc_client_add_net irc_net_info, implement --defaults cmd opt and lua_client_connect Tero Marttila <terom@fixme.fi> parents: 87 diff changeset	54	* Set the default parameters to use for e.g. add_net.
f357f835f0d5 add irc_client_defaults to apply default values for irc_client_add_net irc_net_info, implement --defaults cmd opt and lua_client_connect Tero Marttila <terom@fixme.fi> parents: 87 diff changeset	55	*
f357f835f0d5 add irc_client_defaults to apply default values for irc_client_add_net irc_net_info, implement --defaults cmd opt and lua_client_connect Tero Marttila <terom@fixme.fi> parents: 87 diff changeset	56	* The irc_client_defaults struct itself is copied, but not its contents.
f357f835f0d5 add irc_client_defaults to apply default values for irc_client_add_net irc_net_info, implement --defaults cmd opt and lua_client_connect Tero Marttila <terom@fixme.fi> parents: 87 diff changeset	57	*
f357f835f0d5 add irc_client_defaults to apply default values for irc_client_add_net irc_net_info, implement --defaults cmd opt and lua_client_connect Tero Marttila <terom@fixme.fi> parents: 87 diff changeset	58	* @param client the IRC client
f357f835f0d5 add irc_client_defaults to apply default values for irc_client_add_net irc_net_info, implement --defaults cmd opt and lua_client_connect Tero Marttila <terom@fixme.fi> parents: 87 diff changeset	59	* @param defaults the defaults to use, not copied
f357f835f0d5 add irc_client_defaults to apply default values for irc_client_add_net irc_net_info, implement --defaults cmd opt and lua_client_connect Tero Marttila <terom@fixme.fi> parents: 87 diff changeset	60	*/
f357f835f0d5 add irc_client_defaults to apply default values for irc_client_add_net irc_net_info, implement --defaults cmd opt and lua_client_connect Tero Marttila <terom@fixme.fi> parents: 87 diff changeset	61	void irc_client_set_defaults (struct irc_client client, const struct irc_client_defaults defaults);
f357f835f0d5 add irc_client_defaults to apply default values for irc_client_add_net irc_net_info, implement --defaults cmd opt and lua_client_connect Tero Marttila <terom@fixme.fi> parents: 87 diff changeset	62
f357f835f0d5 add irc_client_defaults to apply default values for irc_client_add_net irc_net_info, implement --defaults cmd opt and lua_client_connect Tero Marttila <terom@fixme.fi> parents: 87 diff changeset	63	/**
f357f835f0d5 add irc_client_defaults to apply default values for irc_client_add_net irc_net_info, implement --defaults cmd opt and lua_client_connect Tero Marttila <terom@fixme.fi> parents: 87 diff changeset	64	* Add a new IRC network, using any default values set using irc_client_set_defaults() to replace NULL values in the
f357f835f0d5 add irc_client_defaults to apply default values for irc_client_add_net irc_net_info, implement --defaults cmd opt and lua_client_connect Tero Marttila <terom@fixme.fi> parents: 87 diff changeset	65	* given \a net_info.
f357f835f0d5 add irc_client_defaults to apply default values for irc_client_add_net irc_net_info, implement --defaults cmd opt and lua_client_connect Tero Marttila <terom@fixme.fi> parents: 87 diff changeset	66	*
f357f835f0d5 add irc_client_defaults to apply default values for irc_client_add_net irc_net_info, implement --defaults cmd opt and lua_client_connect Tero Marttila <terom@fixme.fi> parents: 87 diff changeset	67	* Use of raw_socket is not supported.
63 d399a1d915a3 start reworking option-parsing, but --module/--config is still unimplemented Tero Marttila <terom@fixme.fi> parents: 55 diff changeset	68	*
d399a1d915a3 start reworking option-parsing, but --module/--config is still unimplemented Tero Marttila <terom@fixme.fi> parents: 55 diff changeset	69	* @param client the irc_client state
d399a1d915a3 start reworking option-parsing, but --module/--config is still unimplemented Tero Marttila <terom@fixme.fi> parents: 55 diff changeset	70	* @param net_ptr used to return the new irc_net if not NULL
d399a1d915a3 start reworking option-parsing, but --module/--config is still unimplemented Tero Marttila <terom@fixme.fi> parents: 55 diff changeset	71	* @param net_info info required to identify and connect to the network
87 f0db6ebf18b9 documentation tweaks Tero Marttila <terom@fixme.fi> parents: 63 diff changeset	72	* @param err returned error info
53 12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	73	*/
98 f357f835f0d5 add irc_client_defaults to apply default values for irc_client_add_net irc_net_info, implement --defaults cmd opt and lua_client_connect Tero Marttila <terom@fixme.fi> parents: 87 diff changeset	74	err_t irc_client_add_net (struct irc_client client, struct irc_net net_ptr, const struct irc_net_info net_info, struct error_info *err);
53 12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	75
12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	76	/**
12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	77	* Get a pre-existing IRC network by name
12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	78	*/
12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	79	struct irc_net* irc_client_get_net (struct irc_client client, const char network);
12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	80
12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	81	/**
55 6f7f6ae729d0 'working' modules code, and convert irc_log to use said interface, but we've hit the limits on our Makefile, and the compiled module doesn't really work Tero Marttila <terom@fixme.fi> parents: 53 diff changeset	82	* Get an irc_chan by network/channel name
6f7f6ae729d0 'working' modules code, and convert irc_log to use said interface, but we've hit the limits on our Makefile, and the compiled module doesn't really work Tero Marttila <terom@fixme.fi> parents: 53 diff changeset	83	*/
6f7f6ae729d0 'working' modules code, and convert irc_log to use said interface, but we've hit the limits on our Makefile, and the compiled module doesn't really work Tero Marttila <terom@fixme.fi> parents: 53 diff changeset	84	struct irc_chan* irc_client_get_chan (struct irc_client client, const char network, const char *channel);
6f7f6ae729d0 'working' modules code, and convert irc_log to use said interface, but we've hit the limits on our Makefile, and the compiled module doesn't really work Tero Marttila <terom@fixme.fi> parents: 53 diff changeset	85
6f7f6ae729d0 'working' modules code, and convert irc_log to use said interface, but we've hit the limits on our Makefile, and the compiled module doesn't really work Tero Marttila <terom@fixme.fi> parents: 53 diff changeset	86	/**
53 12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	87	* Quit cleanly from all our IRC networks.
12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	88	*
12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	89	* XXX: currently no way to indicate once we've quit all of them
12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	90	*/
12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	91	err_t irc_client_quit (struct irc_client client, const char message);
12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	92
12d806823775 add irc_client module, plus nexus.h header Tero Marttila <terom@fixme.fi> parents: diff changeset	93	#endif

author	Tero Marttila <terom@fixme.fi>
	Tue, 31 Mar 2009 22:09:53 +0300
changeset 98	f357f835f0d5
parent 87	f0db6ebf18b9
child 217	7728d6ec3abf
permissions	-rw-r--r--