imv/imc header cosmetics

This commit is contained in:
Andreas Steffen
2010-11-09 20:43:50 +01:00
parent e6b6fc881f
commit 9b43ae9cee
4 changed files with 45 additions and 41 deletions
+18 -16
View File
@@ -22,11 +22,13 @@
#define IMC_H_
#include <tnc/tncifimc.h>
#include <library.h>
typedef struct imc_t imc_t;
/typedef struct imc_t imc_t;
/**
* Controls a single Integrity Measurement Collector (IMC)
*/
struct imc_t {
/**
@@ -35,9 +37,9 @@ struct imc_t {
* identifier that the IMC must use when calling TNC Client callback functions.
*
* @param imcID IMC ID assigned by TNCC
* @param minVersion Minimum API version supported by TNCC
* @param maxVersion Maximum API version supported by TNCC
* @param OutActualVersion Mutually supported API version number
* @param minVersion minimum API version supported by TNCC
* @param maxVersion maximum API version supported by TNCC
* @param OutActualVersion mutually supported API version number
* @return TNC result code
*/
TNC_Result (*initialize)(TNC_IMCID imcID,
@@ -50,8 +52,8 @@ struct imc_t {
* the network connection identified by connectionID has changed to newState.
*
* @param imcID IMC ID assigned by TNCC
* @param connectionID Network connection ID assigned by TNCC
* @param newState New network connection state
* @param connectionID network connection ID assigned by TNCC
* @param newState new network connection state
* @return TNC result code
*/
TNC_Result (*notify_connection_change)(TNC_IMCID imcID,
@@ -63,7 +65,7 @@ struct imc_t {
* Handshake is beginning and solicit messages from IMCs for the first batch.
*
* @param imcID IMC ID assigned by TNCC
* @param connectionID Network connection ID assigned by TNCC
* @param connectionID network connection ID assigned by TNCC
* @return TNC result code
*/
TNC_Result (*begin_handshake)(TNC_IMCID imcID,
@@ -76,10 +78,10 @@ struct imc_t {
* is indicated by messageType.
*
* @param imcID IMC ID assigned by TNCS
* @param connectionID Network connection ID assigned by TNCC
* @param message Reference to buffer containing message
* @param messageLength Number of octets in message
* @param messageType Message type of message
* @param connectionID network connection ID assigned by TNCC
* @param message reference to buffer containing message
* @param messageLength number of octets in message
* @param messageType message type of message
* @return TNC result code
*/
TNC_Result (*receive_message)(TNC_IMCID imcID,
@@ -94,7 +96,7 @@ struct imc_t {
* to send a message in the batch of IMC messages currently being collected.
*
* @param imcID IMC ID assigned by TNCC
* @param connectionID Network connection ID assigned by TNCC
* @param connectionID network connection ID assigned by TNCC
* @return TNC result code
*/
TNC_Result (*batch_ending)(TNC_IMCID imcID,
@@ -117,7 +119,7 @@ struct imc_t {
* pointers to any other TNCS functions.
*
* @param imcID IMC ID assigned by TNCC
* @param bindFunction Pointer to TNC_TNCC_BindFunction
* @param bindFunction pointer to TNC_TNCC_BindFunction
* @return TNC result code
*/
TNC_Result (*provide_bind_function)(TNC_IMCID imcID,
@@ -147,8 +149,8 @@ struct imc_t {
/**
* Sets the supported message types of an imc_t object.
*
* @param supported_types List of messages type supported by IMC
* @param type_count Number of supported message types
* @param supported_types list of messages type supported by IMC
* @param type_count number of supported message types
*/
void (*set_message_types)(imc_t *this, TNC_MessageTypeList supported_types,
TNC_UInt32 type_count);
+5 -5
View File
@@ -35,8 +35,8 @@ struct imc_manager_t {
/**
* Add an IMC instance
*
* @param imc IMC instance
* @return TRUE if initialization successful
* @param imc IMC instance
* @return TRUE if initialization successful
*/
bool (*add)(imc_manager_t *this, imc_t *imc);
@@ -52,7 +52,7 @@ struct imc_manager_t {
/**
* Begin a handshake between the IMCs and a connection
*
* @param id Connection ID
* @param id Connection ID
*/
void (*begin_handshake)(imc_manager_t *this, TNC_ConnectionID id);
@@ -60,8 +60,8 @@ struct imc_manager_t {
* Sets the supported message types reported by a given IMC
*
* @param id ID of reporting IMC
* @param supported_types List of messages type supported by IMC
* @param type_count Number of supported message types
* @param supported_types list of messages type supported by IMC
* @param type_count number of supported message types
* @return TNC result code
*/
TNC_Result (*set_message_types)(imc_manager_t *this,
+18 -16
View File
@@ -22,11 +22,13 @@
#define IMV_H_
#include <tnc/tncifimv.h>
#include <library.h>
typedef struct imv_t imv_t;
/**
* Controls a single Integrity Measurement Verifier (IMV)
*/
struct imv_t {
/**
@@ -35,10 +37,10 @@ struct imv_t {
* identifier that the IMV must use when calling TNC Server callback functions.
*
* @param imvID IMV ID assigned by TNCS
* @param minVersion Minimum API version supported
* @param maxVersion Maximum API version supported by TNCS
* @param OutActualVersion Mutually supported API version number
* @return TNC result code
* @param minVersion minimum API version supported
* @param maxVersion maximum API version supported by TNCS
* @param OutActualVersion mutually supported API version number
* @return TNC result code
*/
TNC_Result (*initialize)(TNC_IMVID imvID,
TNC_Version minVersion,
@@ -50,8 +52,8 @@ struct imv_t {
* the network connection identified by connectionID has changed to newState.
*
* @param imvID IMV ID assigned by TNCS
* @param connectionID Network connection ID assigned by TNCS
* @param newState New network connection state
* @param connectionID network connection ID assigned by TNCS
* @param newState new network connection state
* @return TNC result code
*/
TNC_Result (*notify_connection_change)(TNC_IMVID imvID,
@@ -64,7 +66,7 @@ struct imv_t {
* recommendations from IMVs that have not yet provided a recommendation.
*
* @param imvID IMV ID assigned by TNCS
* @param connectionID Network connection ID assigned by TNCS
* @param connectionID network connection ID assigned by TNCS
* @return TNC result code
*/
TNC_Result (*solicit_recommendation)(TNC_IMVID imvID,
@@ -77,10 +79,10 @@ struct imv_t {
* is indicated by messageType.
*
* @param imvID IMV ID assigned by TNCS
* @param connectionID Network connection ID assigned by TNCS
* @param message Reference to buffer containing message
* @param messageLength Number of octets in message
* @param messageType Message type of message
* @param connectionID network connection ID assigned by TNCS
* @param message reference to buffer containing message
* @param messageLength number of octets in message
* @param messageType message type of message
* @return TNC result code
*/
TNC_Result (*receive_message)(TNC_IMVID imvID,
@@ -95,7 +97,7 @@ struct imv_t {
* to send a message in the batch of IMV messages currently being collected.
*
* @param imvID IMV ID assigned by TNCS
* @param connectionID Network connection ID assigned by TNCS
* @param connectionID network connection ID assigned by TNCS
* @return TNC result code
*/
TNC_Result (*batch_ending)(TNC_IMVID imvID,
@@ -117,7 +119,7 @@ struct imv_t {
* pointers to any other TNCS functions.
*
* @param imvID IMV ID assigned by TNCS
* @param bindFunction Pointer to TNC_TNCS_BindFunction
* @param bindFunction pointer to TNC_TNCS_BindFunction
* @return TNC result code
*/
TNC_Result (*provide_bind_function)(TNC_IMVID imvID,
@@ -147,8 +149,8 @@ struct imv_t {
/**
* Sets the supported message types of an imv_t object.
*
* @param supported_types List of messages type supported by IMV
* @param type_count Number of supported message types
* @param supported_types list of messages type supported by IMV
* @param type_count number of supported message types
*/
void (*set_message_types)(imv_t *this, TNC_MessageTypeList supported_types,
TNC_UInt32 type_count);
+4 -4
View File
@@ -35,8 +35,8 @@ struct imv_manager_t {
/**
* Add an IMV instance
*
* @param imv IMV instance
* @return TRUE if initialization successful
* @param imv IMV instance
* @return TRUE if initialization successful
*/
bool (*add)(imv_manager_t *this, imv_t *imv);
@@ -53,8 +53,8 @@ struct imv_manager_t {
* Sets the supported message types reported by a given IMV
*
* @param id ID of reporting IMV
* @param supported_types List of messages type supported by IMV
* @param type_count Number of supported message types
* @param supported_types list of messages type supported by IMV
* @param type_count number of supported message types
* @return TNC result code
*/
TNC_Result (*set_message_types)(imv_manager_t *this,