cinterface.h File Reference

#include <cybergarage/typedef.h>
#include <cybergarage/util/cstring.h>
#include <cybergarage/util/clist.h>

Data Structures
struct	_CgNetworkInterface
Defines
#define	CG_NET_IPV4_ADDRSTRING_MAXSIZE   ((3*4)+(1*3)+1)
#define	CG_NET_IPV6_ADDRSTRING_MAXSIZE   (1+(8*4)+(1*7)+1+1)
#define	cg_net_interface_next(netIf)   (CgNetworkInterface *)cg_list_next((CgList *)netIf)
#define	cg_net_interface_remove(netIf)   cg_list_remove((CgList *)netIf)
#define	cg_net_interfacelist_clear(netIfList)   cg_list_clear((CgList *)netIfList, (CG_LIST_DESTRUCTORFUNC)cg_net_interface_delete)
#define	cg_net_interfacelist_size(netIfList)   cg_list_size((CgList *)netIfList)
#define	cg_net_interfacelist_gets(netIfList)   (CgNetworkInterface *)cg_list_next((CgList *)netIfList)
#define	cg_net_interfacelist_add(netIfList, netIf)   cg_list_add((CgList *)netIfList, (CgList *)netIf)
Typedefs
typedef _CgNetworkInterface	CgNetworkInterface
typedef _CgNetworkInterface	CgNetworkInterfaceList
Functions
char *	cg_net_getinterfaceidaddress (int id)
CgNetworkInterface *	cg_net_interface_new ()
void	cg_net_interface_delete (CgNetworkInterface *netIf)
CgNetworkInterface *	cg_net_interface_getany ()
void	cg_net_interface_setname (CgNetworkInterface *netIf, char *name)
char *	cg_net_interface_getname (CgNetworkInterface *netIf)
void	cg_net_interface_setaddress (CgNetworkInterface *netIf, char *ipaddr)
char *	cg_net_interface_getaddress (CgNetworkInterface *netIf)
void	cg_net_interface_setindex (CgNetworkInterface *netIf, int index)
int	cg_net_interface_getindex (CgNetworkInterface *netIf)
int	cg_net_interface_cmp (CgNetworkInterface *netIfA, CgNetworkInterface *netIfB)
CgNetworkInterfaceList *	cg_net_interfacelist_new ()
void	cg_net_interfacelist_delete (CgNetworkInterfaceList *netIfList)
CgNetworkInterface *	cg_net_interfacelist_get (CgNetworkInterfaceList *netIfList, char *name)
void	cg_net_interfacelist_getchanges (CgNetworkInterfaceList *netIfListOld, CgNetworkInterfaceList *netIfListNew, CgNetworkInterfaceList *netIfListAdded, CgNetworkInterfaceList *netIfListRemoved)
int	cg_net_gethostinterfaces (CgNetworkInterfaceList *netIfList)
BOOL	cg_net_isipv6address (char *addr)
int	cg_net_getipv6scopeid (char *addr)

---

Define Documentation

#define cg_net_interface_next

(

netIf

)

(CgNetworkInterface *)cg_list_next((CgList *)netIf)

#define cg_net_interface_remove

(

netIf

)

cg_list_remove((CgList *)netIf)

#define cg_net_interfacelist_add	(	netIfList,
		netIf		)	cg_list_add((CgList *)netIfList, (CgList *)netIf)

#define cg_net_interfacelist_clear

(

netIfList

)

cg_list_clear((CgList *)netIfList, (CG_LIST_DESTRUCTORFUNC)cg_net_interface_delete)

#define cg_net_interfacelist_gets

(

netIfList

)

(CgNetworkInterface *)cg_list_next((CgList *)netIfList)

#define cg_net_interfacelist_size

(

netIfList

)

cg_list_size((CgList *)netIfList)

#define CG_NET_IPV4_ADDRSTRING_MAXSIZE   ((3*4)+(1*3)+1)

#define CG_NET_IPV6_ADDRSTRING_MAXSIZE   (1+(8*4)+(1*7)+1+1)

---

Typedef Documentation

typedef struct _CgNetworkInterface CgNetworkInterface

typedef struct _CgNetworkInterface CgNetworkInterfaceList

---

Function Documentation

int cg_net_gethostinterfaces

(

CgNetworkInterfaceList *

netIfList

)

char* cg_net_getinterfaceidaddress

(

int

id

)

int cg_net_getipv6scopeid

(

char *

addr

)

int cg_net_interface_cmp	(	CgNetworkInterface *	netIfA,
		CgNetworkInterface *	netIfB
	)

Compares two interfaces based on IP-address.

void cg_net_interface_delete

(

CgNetworkInterface *

netIf

)

char* cg_net_interface_getaddress

(

CgNetworkInterface *

netIf

)

CgNetworkInterface* cg_net_interface_getany

(

)

int cg_net_interface_getindex

(

CgNetworkInterface *

netIf

)

char* cg_net_interface_getname

(

CgNetworkInterface *

netIf

)

CgNetworkInterface* cg_net_interface_new

(

)

void cg_net_interface_setaddress	(	CgNetworkInterface *	netIf,
		char *	ipaddr
	)

void cg_net_interface_setindex	(	CgNetworkInterface *	netIf,
		int	index
	)

void cg_net_interface_setname	(	CgNetworkInterface *	netIf,
		char *	name
	)

void cg_net_interfacelist_delete

(

CgNetworkInterfaceList *

netIfList

)

CgNetworkInterface* cg_net_interfacelist_get	(	CgNetworkInterfaceList *	netIfList,
		char *	name
	)

void cg_net_interfacelist_getchanges	(	CgNetworkInterfaceList *	netIfListOld,
		CgNetworkInterfaceList *	netIfListNew,
		CgNetworkInterfaceList *	netIfListAdded,
		CgNetworkInterfaceList *	netIfListRemoved
	)

Gets changes in the two given (aka old and new) interface lists. Changes are resolved based on IP-addresses.

Parameters:

	netIfListOld	List of the old interfaces. It is changed!
	netIfListNew	List of the new interfaces. It is changed!
	netIfListAdded	List to store interfaces, which were in netIfListNew, but were not in netIfListOld. May be NULL.
	netIfListRemoved	List to store interfaces, which were in netIfListOld, but were not in netIfListNew.

CgNetworkInterfaceList* cg_net_interfacelist_new

(

)

BOOL cg_net_isipv6address

(

char *

addr

)

---