n_network.h File Reference

Network Engine. More...

#include "n_common.h"
#include "n_str.h"
#include "n_list.h"
#include "n_hash.h"

Include dependency graph for n_network.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	N_SOCKET
	Structure of a N_SOCKET. More...
struct	NETWORK
	Structure of a NETWORK. More...
struct	NETWORK_POOL
	structure of a network pool More...

Macros
#define	HEAD_CODE   3
	Code of a HEAD message. More...
#define	HEAD_SIZE   10
	Size of a HEAD message. More...
#define	N_ENUM_netw_code_type(_)
	Network codes definition. More...
#define	NETWORK_CONSECUTIVE_SEND_TIMEOUT   8192
	Flag to set consecutive send waiting timeout More...
#define	NETWORK_DEPLETE_TIMEOUT   4096
	Flag to set send buffer depletion timeout More...
#define	NETWORK_IPALL   0
	Flag for auto detection by OS of ip version to use. More...
#define	NETWORK_IPV4   1
	Flag to force IPV4 More...
#define	NETWORK_IPV6   2
	Flag to force IPV6 More...
#define	SOCKET   SOCKET_TYPE
	socket macro shortcut More...

Typedefs
typedef int(*	netw_func) (SOCKET, char *, NSTRBYTE)
	send/recv func ptr type More...
typedef int	SOCKET_TYPE
	default socket declaration More...

Functions
	N_ENUM_DECLARE (N_ENUM_netw_code_type, __netw_code_type)
	Network codes declaration.
NETWORK *	netw_accept_from (NETWORK *from)
	make a normal blocking 'accept' . More...
NETWORK *	netw_accept_from_ex (NETWORK *from, int send_list_limit, int recv_list_limit, int non_blocking, int *retval)
	make a normal 'accept' . More...
NETWORK *	netw_accept_nonblock_from (NETWORK *from, int blocking)
	make a normal blocking 'accept' . More...
int	netw_add_msg (NETWORK *netw, N_STR *msg)
	Add a message to send in aimed NETWORK. More...
int	netw_add_msg_ex (NETWORK *netw, char *str, unsigned int length)
	Add a message to send in aimed NETWORK. More...
int	netw_close (NETWORK **netw)
	Closing a specified Network, destroy queues, free the structure. More...
int	netw_connect (NETWORK **netw, char *host, char *port, int ip_version)
	Use this to connect a NETWORK to any listening one, unrestricted send/recv lists. More...
int	netw_connect_ex (NETWORK **netw, char *host, char *port, int send_list_limit, int recv_list_limit, int ip_version)
	Use this to connect a NETWORK to any listening one. More...
int	netw_destroy_pool (NETWORK_POOL **netw_pool)
	free a NETWORK_POOL *pool More...
N_STR *	netw_get_msg (NETWORK *netw)
	Get a message from aimed NETWORK. More...
int	netw_get_queue_status (NETWORK *netw, int *nb_to_send, int *nb_to_read)
	retrieve network send queue status More...
int	netw_get_state (NETWORK *netw, int *state, int *thr_engine_status)
	Get the state of a network. More...
int	netw_init_wsa (int mode, int v1, int v2)
	Do not directly use, internal api. More...
int	netw_make_listening (NETWORK **netw, char *addr, char *port, int nbpending, int ip_version)
	Make a NETWORK be a Listening network. More...
NETWORK_POOL *	netw_new_pool (int nb_min_element)
	return a new network pool of nb_min_element More...
int	netw_pool_add (NETWORK_POOL *netw_pool, NETWORK *netw)
	add a NETWORK *netw to a NETWORK_POOL *pool More...
int	netw_pool_broadcast (NETWORK_POOL *netw_pool, NETWORK *from, N_STR *net_msg)
	add net_msg to all network in netork pool More...
int	netw_pool_nbclients (NETWORK_POOL *netw_pool)
	return the number of networks in netw_pool More...
void	netw_pool_netw_close (void *netw_ptr)
	close a network from a network pool More...
int	netw_pool_remove (NETWORK_POOL *netw_pool, NETWORK *netw)
	remove a NETWORK *netw to a NETWORK_POOL *pool More...
void *	netw_recv_func (void *NET)
	To Thread Receiving function. More...
void *	netw_send_func (void *NET)
	Thread send function. More...
int	netw_send_ident (NETWORK *netw, int type, int id, N_STR *name, N_STR *passwd)
	Add a formatted NETWMSG_IDENT message to the specified network. More...
int	netw_send_ping (NETWORK *netw, int type, int id_from, int id_to, int time)
	Add a ping reply to the network. More...
int	netw_send_position (NETWORK *netw, int id, double X, double Y, double vx, double vy, double acc_x, double acc_y, int time_stamp)
	Add a formatted NETWMSG_IDENT message to the specified network. More...
int	netw_send_quit (NETWORK *netw)
	Add a formatted NETMSG_QUIT message to the specified network. More...
int	netw_send_string_to (NETWORK *netw, int id_to, N_STR *name, N_STR *chan, N_STR *txt, int color)
	Add a string to the network, aiming a specific user. More...
int	netw_send_string_to_all (NETWORK *netw, N_STR *name, N_STR *chan, N_STR *txt, int color)
	Add a string to the network, aiming all server-side users. More...
int	netw_set (NETWORK *netw, int flag)
	Restart or reset the specified network ability. More...
int	netw_set_blocking (NETWORK *netw, unsigned long int is_blocking)
	Modify blocking socket mode. More...
int	netw_set_user_id (NETWORK *netw, int id)
	associate an id and a network More...
int	netw_setsockopt (NETWORK *netw, int optname, int value)
	Modify common socket options on the given netw. More...
int	netw_start_thr_engine (NETWORK *netw)
	Start the NETWORK netw Threaded Engine. More...
int	netw_stop_thr_engine (NETWORK *netw)
	Stop a NETWORK connection sending and receing thread. More...
int	netw_wait_close (NETWORK **netw)
	Wait for peer closing a specified Network, destroy queues, free the structure. More...
int	netw_wait_close_timed (NETWORK **netw, size_t timeout)
	Wait for peer closing a specified Network, destroy queues, free the structure. More...
N_STR *	netw_wait_msg (NETWORK *netw, size_t refresh, size_t timeout)
	Wait a message from aimed NETWORK. More...
int	recv_data (SOCKET s, char *buf, NSTRBYTE n)
	recv data from the socket More...
int	recv_php (SOCKET s, int *_code, char **buf)
	recv data from the socket More...
int	send_data (SOCKET s, char *buf, NSTRBYTE n)
	send data onto the socket More...
int	send_php (SOCKET s, int _code, char *buf, int n)
	send data onto the socket More...

Detailed Description

Network Engine.

Author

Castagnier Mickael

Version

2.0

Date

11/03/2015

Definition in file n_network.h.