Documentation from freeway.h

Introduction	[top]

ROV - Easy applications from C

Copyright - © Jason Tribbeck / 7th ARM 1994-2001

Contributing authors - Jason Tribbeck

File - freeway.h

Type - helper

Description

The freeway helper is an interface to the Freeway module. It is experimental, and has not been properly debugged. Also note that the documentation has come from looking at the source, rather than from anything else, so it may be incorrect.

freeway_register	[top]

Register/deregister with Freeway.

Parameters:

 - int flags - the Freeway flags.
 - int type - the Freeway type.
 - char *name - the Freeway object name.
 - int desc_len - the object descriptor length.

Returns:

 -  non-zero for success.

int freeway_register(int flags,
		     int type,
		     char *name,
		     int desc_len);

See also: Freeway flags

freeway_write	[top]

Creates/removes a Freeway object.

Parameters:

 - int flags - the Freeway flags.
 - int type - the Freeway type.
 - char *name - the object name.
 - int desc_len - the descriptor length.
 - void *descriptor - the pointer to the descriptor.
 - int auth - the authentication.

Returns:

 -  non-zero for success.

int freeway_write(int flags,
		  int type,
		  char *name,
		  int desc_len,
		  void *descriptor,
		  int auth);

See also: Freeway flags

freeway_read	[top]

Reads a Freeway object.

Parameters:

 - int flags - the Freeway flags.
 - int type - the Freeway type.
 - char *name - the object name.
 - int desc_len - the descriptor length.
 - void *descriptor - the pointer to the descriptor.
 - int auth - the authentication.

Returns:

 -  descriptor length, or -1 for failure.

int freeway_read(int flags,
		 int type,
		 char *name,
		 int desc_len,
		 void *descriptor,
		 int auth);

See also: Freeway flags

Freeway flags	[top]

#define FREEWAY_ADD		(0<<0)
#define FREEWAY_REMOVE		(1<<0)
#define FREEWAY_REGISTER	(0<<0)
#define FREEWAY_DEREGISTER	(1<<0)
#define FREEWAY_AUTHENTICATE	(1<<1)
#define FREEWAY_UNAUTHENTICATE	(0<<1)
#define FREEWAY_NAMED		(1<<2)
#define FREEWAY_UNNAMED		(0<<2)

Generated Thu Feb 7 23:22:51 2002