NIDB API (not complete)

author: Dan K. Pham
last update: May 2000
 

Content


 
 

HOST DATABASE


Field Name
Type
Description
regID uint32_t -
host_entid uint32_t Host entity identifier
policy uint32_t Host policy: public or private
num_ipaddrs uint32_t -
ipaddr_nbo uint32_t -
hostname char [64] FQN of host
region char [64] Bug - workaround for limitation in zkDBOTypeStr
servoperator char [64] Bug - workaround for limitation in zkDBOTypeStr
Function name
Access (Read/Write)
Description
frNtdbReplaceHost
W
Replaces the current host data in the HOST database and sets the entity last update time in the ENTITY LAST UPDATE TIME database. It calls frNtdbReplaceObject() (which calls zkDBReplace()) and frNidbSetEntityLastUpdateTS() (which calls zkAA()). The 'replaced' flag is set appropriately.
frNtdbGetEntityDBOUsing-
EntityIdentAndTypeStr
R
Calls frNtdbGetEntityDBOUsingEntityIdentAndType() after converting the type string into a FrEntIdType object. Refer to frNtdbGetEntityDBOUsingEntityIdentAndType() for more details.
frNtdbGetEntityDBOUsing-
EntityIdentAndType
R
Gets the entity DBO (Aip DBO, Host DBO, Node DBO or Link DBO) from the TOPOLOGY database or from the HOST database by specifying an entity identifier and a type. If the type is FRENT_TYPE_MAIP, FRENT_TYPE_FMG, FRENT_TYPE_NIDB, FRENT_TYPE_NYM_SRV, FRENT_TYPE_SER_SRV, FRENT_TYPE_TOK_SRV, FRENT_TYPE_KEYQRY_SRV, FRENT_TYPE_KEYUPD_SRV, FRENT_TYPE_NNTP_SRV, FRENT_TYPE_NIQS, FRENT_TYPE_NISS, FRENT_TYPE_AIP or FRENT_TYPE_LINK, it
calls frNidbEidFetchDS() to the topoDB. If the type is FRENT_TYPE_HOST, il calls frNidbEidFetchDS() to the hostDB. Else, it returns an error. 
frNtdbDeleteHost
W
Deletes a host from the HOST database, and deletes the appropriate data in the ENTITY LAST UPDATE TIME database as well. It calls frNtdbDeleteObject() and specifies the entity identifier to delete the host.
frNtdbGetHostDS
R
Gets the host from the HOST database. It first gets the entity identifier by calling
frNidbGetEntityIdentifier() (which calls zkAAGet()) and then uses the entity identifier to fetch the HOST database with frNidbEidFetchDS() (which calls zkDBFetch()).
frNtdbGetAllEntityDBOsUsing-
EntityIdent
R
Fetches the HOST database and the ENTITY ID database to get the entity DBO and the host DBO. It fetches the ENTITY ID database by calling frNidbEidFetchEDS() (which calls zkAAGet()) and fetches the HOST database by calling frNidbEidFetchDS() (which calls zkFetchDB()).
frNtdbEntityGetIpAddr
R
This function gets the IP address from the HOST database using a host name. It calls frNtdbGetHostDS() to get the HOST data structure and if it is found, it retrives the IP address of the host.
frNtdbGetEntityDBOUsingEntityIdentAndType
R
It fetches the HOST database or the TOPOLOGY database to get the DBO of an entity given its identifier. If the type is
FRENT_TYPE_MAIP, FRENT_TYPE_FMG, FRENT_TYPE_NIDB, FRENT_TYPE_NYM_SRV, FRENT_TYPE_SER_SRV, FRENT_TYPE_TOK_SRV, FRENT_TYPE_KEYQRY_SRV, FRENT_TYPE_KEYUPD_SRV
FRENT_TYPE_NNTP_SRV, FRENT_TYPE_NIQS, FRENT_TYPE_NISS, FRENT_TYPE_AIP or FRENT_TYPE_LINK, it fetches the TOPOLOGY database. If the type is FRENT_TYPE_HOST, then the HOST database is fetched instead. In either cases, frNidbEidFetchDS() is called.

 

STATE DATABASE


DATA STRUCTURE: T_FrDBOTypeNsdbAip
Field Name
Type
Description
regID uint32_t -
entid uint32_t Entity identifier
reference_date uint32_t Reference date for the info
last_state_date uint32_t The last date the server went up or down.
last_update_date uint32_t The last date of the update.
unavailable_flag uint32_t Entity is unavailable.
up_flag uint32_t Entity is up.
tt1 UINT64_T -
uptime uint32_t Time up since reference.
downtime uint32_t Time down since reference.
msgs_rcvd UINT64_T -
msgs_sent UINT64_T -
msgs_rcvd_1 UINT64_T -
msgs_sent_1 UINT64_T -
msgs_rcvd_2 UINT64_T -
msgs_sent_2 UINT64_T -
num_updates uint32_t -
entity_rating uint32_t -
security_level uint32_t -
OR_entity_rating UINT64_T -
OR_up_flag UINT64_T -
msgs_real_sent UINT64_T -
msgs_real_sent_1 UINT64_T -
msgs_real_sent_2 UINT64_T -
spare_1 UINT64_T -
spare_2 UINT64_T -
spare_3 UINT64_T -
spare_4 UINT64_T -
spare_5 UINT64_T -
total_bytes_in UINT64_T -
total_bytes_out UINT64_T -
connections UINT64_T -
release char[] -
Function name
Access (Read/Write)
Description
frNsdbFetch
R
Fetches the STATE database for the state of a given entity using zkDBFetch().
frNsdbReplace
 W
Replaces a state of a given Aip in the STATE database, and updates the appropriate entry in the ENTITY LAST UPDATE TIME database if the status has changed (if the status_changed flag is true). It calls zkDBReplace() to replace the new state and calls frNidbSetEntityStatusChangeTS() (which calls zkDBReplace()) to change the last update time. 
frNidbGetStatusUpdateSince
 R
Gets the description for a given entity typeset updated since a certain time (specified by the user). First, it calls frNidbGetEntitiesInTypesetUpdatedSince() (which uses zkDBCursor* functions) to get a list of entities/entity identifiers that were updated since a certain period of time. Then, for each element of this list, it calls frNsdbGetEntIdentStatusAndRating() and sets the results into the response object.
frNsdbGetEntIdentStatusAndRating
 R
Fetches the STATE database to get the status and rating of a given entity by calling frNsdbFetchDSforEID(). The rate corresponds to the entity_rating field in the database, and the status corresponds to the up_flag field in the database. This function logs an error message if the entity is marked as unavailable (unavailable_flag field) or if the value of the rating is overflowed. Both the state and the rating will be marked to 0 (zero) if the entity is marked as unavailable.
frNsdbFetchDSforEID
 R
Fetches the STATE database by calling zkDBFetch() using an entity ID specified by the caller.
frNidbGetStatusConnections
 R
Gets the status and ratings for a given entity typeset (specified by entity_mask) updated since a certain time (specified by since). It first calls frNidbGetEntitiesInTypesetUpdatedSince() to get a list of entity identifiers. It then calls frNsdbGetEntIdentStatusAndRating() for each identifier found.

 

TOPOLOGY DATABASE


DATA STRUCTURE: T_FrDBOTypeNtdbAip
Field Name
Type
Description
regID uint32_t -
aip_entid uint32_t AIP  entity identifier
aip_port uint32_t The AIP port number
protocol_vers uint32_t The AIP protocol version number
dh_port uint32_t Diffie-Hellman port number
dh_timeout uint32_t Diffie-Hellman timeout
dh_negotiation uint32_t Diffie-Hellman negotiation
host_entid uint32_t The host upon which this aip resides
Function name
Access (Read/Write)
Description
frNtdbFetch
R
Fetches the TOPOLOGY database and gets the T_FrDBOTypeNtdbAip data structure using the AIP entity identifier. This function calls zkDBFetch() to fetch the database.
frNtdbReplace
W
Replaces the data in the TOPOLOGY database by calling zkDBReplace() (using the AIP entity identifier). It also updates the corresponfding entry in the ENTITY LAST UPDATE TIME database by calling frNidbSetEntityLastUpdateTS() using the same entity identifier.
frNtdbDeleteAip
W
Calls frNtdbDeleteObject() to delete an entry in the TOPOLOGY database using the entity identifier. The ENTITY LAST UPDATE TIME database is also updated (frNidbDeleteEntityLastUpdateTS() is called).

 

DATA STRUCTURE: T_FrDBOTypeNtdbNode
Field Name
Type
Description
regID uint32_t -
node_entid uint32_t Entity identifier
node_port uint32_t The port this entity runs on
num_hosts uint32_t The number of hosts this entity resides on
host_entid uint32_t The host upon which this entity resides
spare1 uint32_t SPARE
spare2 uint32_t SPARE
Function name
Access (Read/Write)
Description
frNtdbDeleteNode
W
Calls frNtdbDeleteObject() to delete an entry in the TOPOLOGY database using the entity identifier. The ENTITY LAST UPDATE TIME database is also updated (frNidbDeleteEntityLastUpdateTS() is called).

 

DATA STRUCTURE: T_FrDBOTypeNtdbLink
Field Name
Type
Description
regID uint32_t -
link_entid uint32_t Link entity identifier
node1_entid uint32_t Low order node entity identifier
node2_entid uint32_t High order node entity identifier
ts_delay uint32_t For this link
ts_pkts uint32_t For this link
ct_on_flag uint32_t Enable cover traffic
spare1 uint32_t SPARE
spare2 uint32_t SPARE
Function name
Access (Read/Write)
Description
frNtdbReplaceLink
W
Replaces the link entry in the TOPOLOGY database (using the link entity identifier) and updates the ENTITY LAST UPDATE TIME database. This function calls frNtdbReplaceObject() which in turn calls zkDBReplace() and frNidbSetEntityLastUpdateTS() using the same entity identifier.
frNtdbDeleteLink
W
Calls frNtdbDeleteObject() to delete an entry in the TOPOLOGY database using the entity identifier. The ENTITY LAST UPDATE TIME database is also updated (frNidbDeleteEntityLastUpdateTS() is called).

 
 

DATA STRUCTURE: T_FrDBOTypeNtdbDetailedNeighbours
Field Name
Type
Description
regID uint32_t -
num_neighbours uint32_t Used for size
dh_port uint32_t Remote node identifier
aip_port uint32_t Aip EntId's of neighbours HACK: actually num neighbours
ent FrEntIdExp The requesting node's entity
neighbour neibr_detail HACK: actually num neighbours

DATA STRUCTURE: neibr_detail
Field Name
Type
Description
ent FrEntIdExp -
ipaddr uint32_t In NBO
dh_port uint32_t Remote node identifier
aip_port uint32_t -
dh_timeout uint32_t -
dh_negotiation uint32_t -
ts_delay uint32_t -
ts_pkts uint32_t -
ct_on_flag uint32_t -
spare1 uint32_t -
spare2 uint32_t -

Other functions related to the TOPOLOGY database:
Function name
Access (Read/Write)
Description
frNtdbGetCompleteLocalTopology
R
It first fetches the TOPOLOGY database (frNidbEidFetchDS) to get the AIP DBO (dh_port and aip_port are set accordingly). Second, it calls frNtdbGetLocalTopologyWithEntIdent() (which calls frNidbEidFetchDS()) to get the neighbours of this AIP (num_neighbours is set appropriately). For each neighbour found, frNidbEidFetchEDS() and frNidbEidFetchDS() are called to fill ipaddr, aip_port, dh_port, dh_timeout, dh_negotiation. Then, the link datas (ts_delay, ts_pkts, ct_on_flag) are filled by calling frNidbGetLinkEntityAndIDFromEntityID2() (to get the link entity identifier) and frNidbEidFetchDS() to fetch the TOPOLOGY database.
frNtdbGetEntityDBOUsingEntityIdentAndTypeStr
R
It converts the type string into the corresponding FrEntIdType object and calls frNtdbGetEntityDBOUsingEntityIdentAndType() by passing its parameters.
frNtdbGetEntityDBOUsingEntityIdentAndType
R
It fetches the HOST database or the TOPOLOGY database to get the DBO of an entity given its identifier. If the type is
FRENT_TYPE_MAIP, FRENT_TYPE_FMG, FRENT_TYPE_NIDB, FRENT_TYPE_NYM_SRV, FRENT_TYPE_SER_SRV, FRENT_TYPE_TOK_SRV, FRENT_TYPE_KEYQRY_SRV, FRENT_TYPE_KEYUPD_SRV
FRENT_TYPE_NNTP_SRV, FRENT_TYPE_NIQS, FRENT_TYPE_NISS, FRENT_TYPE_AIP or FRENT_TYPE_LINK, it fetches the TOPOLOGY database. If the type is FRENT_TYPE_HOST, then the HOST database is fetched instead. In either cases, frNidbEidFetchDS() is called.
frNtdbGetEntityDBOsUsingEntityIdent
R
Given an entity identifier, this function gets the entity DBO and the DBO. It first calls frNidbEidFetchEDS() to get the entity identifier DBO. Depending on the type of this entity (based on the entity identifier DBO that was found), it calls the appropriate function to fetch the right database. It fetches the HOST database of the type is FRENT_TYPE_HOST by calling frNidbEidFetchDS(), or fetches the TOPOLOGY database if the type is FRENT_TYPE_LINK by calling frNidbEidFetchDS().

 
 

NEIGHBOUR DATABASE


DATA STRUCTURE: T_FrDBOTypeNtdbNeighbours
Field Name
Type
Description
regID uint32_t -
num_neighbours uint32_t Used for size
node_entid uint32_t Remote node identifier
neighbour uint32_t [1] Aip EntId's of neighbours HACK: actually num neighbours
Function name
Access (Read/Write)
Description
frNtdbGetLocalTopology
R
It fetches the NEIGHBOUR database to get the topology of an entity.It clears the error object and forwards the call to frNtdbGetLocalTopologyWithEntIdent() which calls frNidbEidFetchDS() (using the entity identifier).

 

Functions related to the NEIGHBOUR database:
Function name
Access (Read/Write)
Description
frNtdbNeighbourAdd
W
Takes two node identifiers in parameter and adds each one as a neighbour of the other one in the NEIGHBOUR database by calling frNtdbFillNeighbourAdd().
frNtdbFillNeighbourAdd() first calls NidbEidFetchDS() to fetch the NEIGHBOUR database. Then, if the node already has the specified neighbour as a neighbour, it returns by not doing anything. If the node does not exist, it creates it, sets the number of neighbours to 1 and adds the neighbour by calling frNidbEidReplaceDS(). If it already exists but does not have the specified neighbour, it increments its number of neighbours and adds the specified neighbour by calling frNidbEidReplaceDS().
frNtdbNeighbourRemove
W
Takes two node identifiers in parameter and removes each one as a neighbour of the other one in the NEIGHBOUR database by calling frNtdbFillNeighbourRemove(). If there is an entry for the specified node, frNtdbFillNeighbourRemove() decrements the number of neighbours appropriately and removes the neighbour (if it is a neighbour). frNidbEidReplaceDS() is called to out the new entry into the database.

 
 

ENTITY DATABASE


DATA STRUCTURE: T_FrDBOTypeEntity
Field Name
Type
Description
regID uint32_t -
ent FrEntIdExp -

Functions related to the ENTITY database:
Function name
Access (Read/Write)
Description
frNidbGetEntityIdentifier
R
Fetches the ENTITY database by calling zkAAGet() using the entity DBO that is passed in parameter.
frNidbGetLinkEntityFromEntityID2
R
It first calls frNidbGetLinkEntityName() (which calls frNidbGetEntityIdentifier() for each node of the link and returns the link entity name) to fill a FrDBOTypeEntityID data structure. It then uses this data structure as a parameter in frNidbGetEntityIdentifier() to get the entity identifier.
frNidbGetLinkEntityAndIDFromEntityID2
R
Same as frNidbGetLinkEntityFromEntityID2(), but returns the FrDBOTypeEntityID data structure on top of the entity identifier.
frNidbEntityGetEidFromTypeAndName
R
Fetches the ENTITY database to get the entity identifier by calling frNidbGetEntityIdentifier(). It first fills a FrDBOTypeEntityID data structure and calls frNidbGetEntityIdentifier().
frNidbEntityGetEntIdentFromTypeAndName
R
Calls frNidbEntityGetEidFromTypeAndName() which returns an object of type FrDBOTypeEntityID and assigns its value to the FrEntIdent data object that was passed in parameter.
frNidbGetEntDboFromEntity
R
Given an entity, this function fetches the ENTITY database to get the entity DBO by calling zkAAGet().
frNidbGetDescObjForEntity
R
Gets the FrNidbObj data structure given its entity. It first calls frNidbGetEntDboFromEntity() to get the entity DBO, and then calls frNidbGetDescObjFromTypeEntityID using this DBO to get the FrNidbObj data structure.
frNidbFindEntIdentUsingEntity
R
Gets the EntityIdent using the FrEntIdent object. It calls frNidbFindEntityIdDboUsingEntity() to get the FrDBOTypeEntityID object, and extracts the FrEntIdent from it.
frNidbGetLinkEntityName
R
This function gets the link entity name from the names (strings) of the two nodes. It calls frNidbGetEntityIdentifier() for each node of the link, and builds the link entity name (string) with the entity identifiers.
frNidbGetLinkEntityFromEntities
R
It does then same thing as frNidbGetLinkEntityName(), but takes the two entity identifiers data structures instead of the names of the two nodes.
frNtdbGetHostDS
R
Given a host entity name (string), this function gets the host record from the database. It first calls frNidbGetEntityIdentifier() to get the entity identifier, and then uses this identifier to fetch the HOST database by caling frNidbEidFetchDS() to get the host DBO.

 

ENTITY IDENTIFIER DATABASE


DATA STRUCTURE: T_FrDBOTypeEntityID
Field Name
Type
Description
regID uint32_t -
entid uint32_t -
last_update FrEntIdent  Used in transmission to track update
ent time_t -

 

Functions related to the ENTITY IDENTIFIER database:
Function name
Access (Read/Write)
Description
frNidbGetLinkEntityAndIDFromEntityIdent2
R
It gets the link entity identifier and the link entity idenfier DBO given 2 node entity identifiers. It calls frNidbEidFetchEDS for each node entity identifiers and uses the entity identifier DBOs (of the nodes) to call frNidbGetLinkEntityAndIDFromEntityID2() (which calls frNidbGetEntityIdentifier()).
frNidbGetLinkEntityFromEntities
R
Given the two entities, it calls frNidbGetLinkEntityName() to get the name of the link. It then calls frEntNew() to allocate memory for a new entity, and fills it with this name and specifies "link" as the type.
frNtdbGetEntityDBOsUsingEntityIdent
R
Given an entity identifier, this function gets the entity DBO and the DBO. It first calls frNidbEidFetchEDS() to get the entity identifier DBO. Depending on the type of this entity (based on the entity identifier DBO that was found), it calls the appropriate function to fetch the right database. It fetches the HOST database of the type is FRENT_TYPE_HOST by calling frNidbEidFetchDS(), or fetches the TOPOLOGY database if the type is FRENT_TYPE_LINK by calling frNidbEidFetchDS().
frNidbGetEntitiesOfType
R
Gets a list of entity identifiers that match a same type. It calls zkAA_Cursor*() functions to fetch the entity identifier database.
frNidbGetEntitiesInTypesetUpdatedSince
R
Get a list of all entity identifiers in an entity typeset. It calls zkAA_Cursor*() functions to fetch the ENTITY IDENTIFIER database, and calls frNidbGetEntityAnyUpdateTS() for each of the records found to see if it matches the "since" criteria. If it does, the record is added to the response list.
frNidbGetEntitiesInTypeset
R
It gets the list of all the entity identifiers in an entity typeset. It simply calls frNidbGetEntitiesInTypesetUpdatedSince using 0 (zero) as the since parameter.
frNidbGetAllEntityIDs
R
It gets a list of all the entity identifiers in the ENTITY IDENTIFIER database.
frNidbEidFetchEDS
R
Fetches the ENTITY IDENTIFIER database to get the entity identifier DBO by calling zkAAGet() using the entity identifier number.
frNtdbQueryListAllEntityIDs
R
It calls frNidbGetEntitiesInTypeset() to get all entities that are one of the following: FRENT_TYPE_AIP, FRENT_TYPE_FMG, FRENT_TYPE_MAIP, FRENT_TYPE_NIQS, FRENT_TYPE_NISS, FRENT_TYPE_NYM_SRV, FRENT_TYPE_TOK_SRV, FRENT_TYPE_KEYQRY_SRV, FRENT_TYPE_HOST.
frNidbGetStatusForEntIdent
R
It gets the status of an entity using its entity identifier. It first calls frNidbEidFetchEDS() to get the entity identifier DBO. It the calls frNsdbGetEntIdentStatusAndRating() to get the state and rating.
frNidbFindEntityIdDboUsingEntity
R
It gets the entity identifier DBO using the entity by calling frNidbGetEntityIdentifier().
frNtdbGetAllEntityDBOsUsingEntityIdent
R
This function fetches the HOST database and the ENTITY ID database to get the entity DBO and the host DBO. It fetches the ENTITY ID database by calling frNidbEidFetchEDS() (which calls zkAAGet()) and fetches the HOST database by calling frNidbEidFetchDS() (which calls zkFetchDB()).
frNidbGetStatusUpdateSince
R
This function gets the description for a given entity typeset updated since a certain time (specified by the user). First, it calls frNidbGetEntitiesInTypesetUpdatedSince() (which uses zkDBCursor* functions) to get a list of entities/entity identifiers that were updated
since a certain period of time. Then, for each element of this list, it calls frNsdbGetEntIdentStatusAndRating() and sets the results into the resp object. 

 
 
 

ENTITY LAST UPDATE TIME DATABASE


DATA STRUCTURE: FrDBOTypeEntityUpdates_T
Field Name
Type
Description
regID uint32_t -
_ds_size uint32_t Internal DS size
ent_ident FrEntIdent  Ent identifier
last_update_ts time_t The last topo change made
status_change_ts time_t The last status change made

 

Functions related to the ENTITY IDENTIFIER database:
Function name
Access (Read/Write)
Description
frNidbSetEntityLastUpdateTS
W
Sets the entity last update time in the ENTITY LAST UPDATE TIME database. It first calls zkAAGet() using the entity identifier to see if the entry exists. It then calls zkAAPut() to replace the current entry with the new time stamp.
frNidbGetEntityLastUpdateTS
R
It fetches the ENTITY LAST UPDATE TIME database by calling zkAAGet() using the entity identifier to get the entity last update time.
frNidbDeleteEntityLastUpdateTS
W
It deletes an entry in the ENTITY LAST UPDATE TIME by calling zkAADelete() using the entitu identifier.
frNidbGetEntityAnyUpdateTS
R
It fetches the ENTITY LAST UPDATE TIME database by calling zkAAGet() using the entity identifier to get the last update time and the status udpate time.
frNidbSetEntityStatusChangeTS
W
Sets the entity status change time in the ENTITY LAST UPDATE TIME database. It first calls zkAAGet() using the entity identifier to see if the entry exists. It then calls zkAAPut() to replace the current entry with the new time stamp.
frNidbGetEntityStatusChangeTS
R
It fetches the ENTITY LAST UPDATE TIME database by calling zkAAGet() using the entity identifier to get the entity status change time.
frNtdbReplaceHost
W
Replaces the current host data in the HOST database and sets the entity last update time in the ENTITY LAST UPDATE TIME database. It calls frNtdbReplaceObject() (which calls zkDBReplace()) and frNidbSetEntityLastUpdateTS() (which calls zkAA()). The 'replaced' flag is set appropriately.
frNtdbDeleteHost
W
Deletes a host from the HOST database, and deletes the appropriate data in the ENTITY LAST
UPDATE TIME database as well. It calls frNtdbDeleteObject() and specifies the entity identifier to delete the host.
frNsdbReplace
W
Replaces a state of a given Aip in the STATE database, and updates the appropriate entry in the ENTITY LAST UPDATE TIME database if the status has changed (if the status_changed flag is true). It calls zkDBReplace() to replace the new state and calls frNidbSetEntityStatusChangeTS() (which calls zkDBReplace()) to change the last update time.

 
 

ARCHIVE DATABASE


Functions related to the ARCHIVE database:
Function name
Access (Read/Write)
Description
frNadbArchive
W
Makes a SQL insertion of the entname, sent, rcvd and downtime into aip_archive. It calls mysql_query().

 
 

GENERIC METHODS



 
Function name
Description
frNidbEidFetchDS
This function is a generic method for fetching the DBO from a database using the entity identifier. The caller specifies the database that is requested, and zkDBFetch() is called on the specified database using the specified entity identifier as a key.
frNidbEidReplaceDS
This function is a generic method for replacing the DBO in a specific database using the entity identifier. zkDBReplace() is called on the specified database using the specified entity identifier as a key.

 
 

SPECIAL FUNCTIONS (Not accessing any database)



 
 
Function name
Description
frNidbCanonLinkEntname
This functions does not involve any database. If the arguments are not NULL, this function makes sure that entname->node2 is greater than entname->node1. If not, it switches thoses values around and returns.
frNidbAipEntityGetIpAndPort
Not implemented.
frNidbDumpStateBuf
This functions does not involve any database. It simply dumps out the information of a given state that is passed as an argument.It calls zkCStrSprintf() to dump the information into the buffer.
frNidbDumpState
This functions does not involve any database. It calls frNidbDumpStateBuf(), callback() and frees the buffer.

The following functions are used to "cast" all entity state information into the FrDBOTypeNsdbAip data structure.
Function name
Description
frNsdbSetStatusForAip
This functions does not involve any database. It takes a FrDBOTypeNsdbAip data structure and all the necessary information in parameter, and fills up the data structure.
frNsdbGetStatusForAip
This functions does not involve any database. It does the opposite task of frNsdbSetStatusForAip() by extracting all the information from the FrDBOTypeNsdbAip data structure and assigning the corresponding values to each variable.
frNsdbSetStatusForWormhole
This functions does not involve any database. It takes a FrDBOTypeNsdbAip data structure and all the necessary information (for a wormhole) in parameter, and fills up the data structure.
frNsdbGetStatusForWormhole
This functions does not involve any database. It does the opposite task of frNsdbSetStatusForWormhole() by extracting all the information from the FrDBOTypeNsdbAip data structure and assigning the corresponding values to each variable.
frNsdbSetStatusForLink_lowEnd
This functions does not involve any database. It takes a FrDBOTypeNsdbAip data structure and all the necessary information (for a link) in parameter, and fills up the data structure.
frNsdbGetStatusForLink_lowEnd
This functions does not involve any database. It does the opposite task of frNsdbSetStatusForLink_lowEnd() by extracting all the information from the FrDBOTypeNsdbAip data structure and assigning the corresponding values to each variable.
frNsdbGetUpStatusForLink
This function does not involve any database. It gets the value of the up_flag field of the FrDBOTypeNsdbAip data structure that was passsed as an argument.
frNsdbSetUpStatusForLink
This function does not involve any database. It sets the value of the up_flag field of the FrDBOTypeNsdbAip data structure that was passsed as an argument.
frNsdbSetStatusForLink_highEnd
This functions does not involve any database. It takes a FrDBOTypeNsdbAip data structure and all the necessary information (for a link) in parameter, and fills up the data structure.
frNsdbGetStatusForLink_highEnd
This functions does not involve any database. It does the opposite task of frNsdbSetStatusForLink_highEnd() by extracting all the information from the FrDBOTypeNsdbAip data structure and assigning the corresponding values to each variable.
frNsdbSetStatusForMaip
This functions does not involve any database. It takes a FrDBOTypeNsdbAip data structure and all the necessary information (for a MAIP) in parameter, and fills up the data structure.
frNsdbGetStatusForMaip
This functions does not involve any database. It does the opposite task of frNsdbSetStatusForMaip() by extracting all the information from the FrDBOTypeNsdbAip data structure and assigning the corresponding values to each variable.