LinkDB

Modules
	GapInit Constants
	LinkDB Structures

Files
file	linkdb.h

Macros
#define	linkDB_Authenticated(connectionHandle)   linkDB_State( (connectionHandle), LINK_AUTHENTICATED )
#define	linkDB_Bonded(connectionHandle)   linkDB_State( (connectionHandle), LINK_BOUND )
#define	linkDB_Encrypted(connectionHandle)   linkDB_State( (connectionHandle), LINK_ENCRYPTED )
#define	linkDB_Up(connectionHandle)   linkDB_State( (connectionHandle), LINK_CONNECTED )

Functions
uint8	linkDB_GetInfo (uint16 connectionHandle, linkDBInfo_t *pInfo)
uint8	linkDB_NumActive (void)
uint8	linkDB_NumConns (void)
uint8	linkDB_State (uint16 connectionHandle, uint8 state)

Detailed Description

This module implements the Link Database Module

Macro Definition Documentation

linkDB_Authenticated

#define linkDB_Authenticated

(

connectionHandle

)

linkDB_State( (connectionHandle), LINK_AUTHENTICATED )

Check to see if the physical link is authenticated.

Parameters

connectionHandle

controller link connection handle.

Returns

TRUE if the link is authenticated

FALSE, otherwise.

linkDB_Bonded

#define linkDB_Bonded

(

connectionHandle

)

linkDB_State( (connectionHandle), LINK_BOUND )

Check to see if the physical link is bonded.

Parameters

connectionHandle

controller link connection handle.

Returns

TRUE if the link is bonded

FALSE, otherwise.

linkDB_Encrypted

#define linkDB_Encrypted

(

connectionHandle

)

linkDB_State( (connectionHandle), LINK_ENCRYPTED )

Check to see if the physical link is encrypted.

Parameters

connectionHandle

controller link connection handle.

Returns

TRUE if the link is encrypted

FALSE, otherwise.

linkDB_Up

#define linkDB_Up

(

connectionHandle

)

linkDB_State( (connectionHandle), LINK_CONNECTED )

Check to see if a physical link is up (connected).

Parameters

connectionHandle

controller link connection handle.

Returns

TRUE if the link is up

FALSE, otherwise.

Function Documentation

linkDB_GetInfo()

uint8 linkDB_GetInfo	(	uint16	connectionHandle,
		linkDBInfo_t *	pInfo
	)

Get information about a link

Copies all of the link information into pInfo. Uses the connection handle to search the link database.

Parameters

connectionHandle	controller link connection handle.
pInfo	output parameter to copy the link information

Returns

SUCCESS

FAILURE connection wasn't found

linkDB_NumActive()

uint8 linkDB_NumActive

(

void

)

Return the number of active connections

Returns

the number of active connections

linkDB_NumConns()

uint8 linkDB_NumConns

(

void

)

Return the maximum number of connections supported.

Returns

the number of connections supported

linkDB_State()

uint8 linkDB_State	(	uint16	connectionHandle,
		uint8	state
	)

Check to see if a physical link is in a specific state.

Parameters

connectionHandle	controller link connection handle.
state	LinkDB Connection State Flags state to look for.

Returns

TRUE if the link is found and state is set in state flags.

FALSE otherwise.