TSP: The Transport Sample Protocol



Generic Consumer Library
[Generic ConsumerTSP Libraries]

Collaboration diagram for Generic Consumer Library:The generic consumer library API. More...

Functions

int32_t generic_consumer (generic_consumer_request_t *req)
 The GenericConsumer command generic API.
int32_t generic_consumer_async_read (generic_consumer_request_t *req)
 The TSP request asynchronous read handler.
int32_t generic_consumer_async_write (generic_consumer_request_t *req)
 The TSP request asynchronous write handler.
TSP_request_type_t generic_consumer_checkargs (generic_consumer_request_t *req)
 Check arguments.
int32_t generic_consumer_close (generic_consumer_request_t *req)
 The TSP request close handler.
TSP_request_type_t generic_consumer_cmd (const char *generic_consumer_request_string)
 Return the TSP request command type from the string passed as parameter.
int32_t generic_consumer_filtered_information (generic_consumer_request_t *req)
 The TSP request filtered information handler.
int32_t generic_consumer_information (generic_consumer_request_t *req)
 The TSP request information handler.
int32_t generic_consumer_open (generic_consumer_request_t *req)
 The TSP request open handler.
void generic_consumer_request_create (generic_consumer_request_t *req)
 Initialise GenericConsumer request.
int32_t generic_consumer_unimplemented_cmd (generic_consumer_request_t *req)
 When unimplemented call this.
void generic_consumer_usage (generic_consumer_request_t *req)
 Print usage of the specified generic_consumer request.


Detailed Description

The generic consumer library API.


Function Documentation

int32_t generic_consumer ( generic_consumer_request_t *  req  ) 

The GenericConsumer command generic API.

Parameters:
req INOUT, The TSP request to be honored

int32_t generic_consumer_async_read ( generic_consumer_request_t *  req  ) 

The TSP request asynchronous read handler.

Parameters:
req IN, the generic_consumer request.

int32_t generic_consumer_async_write ( generic_consumer_request_t *  req  ) 

The TSP request asynchronous write handler.

Parameters:
req IN, the generic_consumer request.

TSP_request_type_t generic_consumer_checkargs ( generic_consumer_request_t *  req  ) 

Check arguments.

Parameters:
req INOUT, req the TSP request for which the arguments should be analyzed

int32_t generic_consumer_close ( generic_consumer_request_t *  req  ) 

The TSP request close handler.

Parameters:
req IN, the generic_consumer request.

TSP_request_type_t generic_consumer_cmd ( const char *  generic_consumer_request_string  ) 

Return the TSP request command type from the string passed as parameter.

Parameters:
generic_consumer_request_string the name of the generic_consumer command

int32_t generic_consumer_filtered_information ( generic_consumer_request_t *  req  ) 

The TSP request filtered information handler.

Parameters:
req IN, the generic_consumer request.

int32_t generic_consumer_information ( generic_consumer_request_t *  req  ) 

The TSP request information handler.

Parameters:
req IN, the generic_consumer request.

int32_t generic_consumer_open ( generic_consumer_request_t *  req  ) 

The TSP request open handler.

Parameters:
req IN, the generic_consumer request.

void generic_consumer_request_create ( generic_consumer_request_t *  req  ) 

Initialise GenericConsumer request.

Parameters:
req OUT, the request to initialize.

int32_t generic_consumer_unimplemented_cmd ( generic_consumer_request_t *  req  ) 

When unimplemented call this.

Parameters:
req IN, the generic_consumer request.

void generic_consumer_usage ( generic_consumer_request_t *  req  ) 

Print usage of the specified generic_consumer request.

Parameters:
req IN, the generic_consumer request.

Framework Home Page.


Beware !! TSP wave is coming...