TSP: The Transport Sample Protocol



Main Page | Modules | Alphabetical List | Data Structures | File List | Data Fields | Globals | Related Pages

tsp_consumer.h File Reference

Go to the source code of this file.

Data Structures

struct  TSP_consumer_information_t
 return all information about a provider More...

struct  TSP_consumer_symbol_info_t
 Structure used to read all symbols info. More...

struct  TSP_consumer_symbol_requested_t
 Structure used to request symbols. More...

struct  TSP_sample_t
 Structure to get each sample. More...


Defines

#define TSP_URL_FORMAT_USAGE   "\TSP URL format is defined by <PROTOCOL://HOST/SERVER:PORT> \n\\tPROTOCOL if omitted, is defaulted to 'rpc' \n\\tHOST if omitted, is defaulted to 'localhost' \n\\tSERVER if omitted, find any TSP server name \n\\tPORT if omitted, find first TSP server number \n\\tSimplified possible syntaxes : \n\\t\tPROTOCOL://HOST/SERVER = PROTOCOL://HOST/SERVER:(find first) \n\\t\tPROTOCOL://HOST/:0 = PROTOCOL://HOST/(find any):0 \n\\t\tPROTOCOL://HOST = PROTOCOL://HOST/(find any):(find first) \n\\t\tPROTOCOL:// or PROTOCOL = PROTOCOL://localhost/(find any):(find first)\n\\t\tvoid, /, //, /// or :/// = rpc://localhost/(find any):(find first) \n\\tOthers may have unpredictable results .. \n"
 Connects to a provider based on a given URL.


Typedefs

typedef void(* TSP_sample_callback_t )(TSP_sample_t *sample, void *user_data)
 Callback function type used to receive a sample item.

typedef void * TSP_provider_t
 Opaque handle type for provider.


Enumerations

enum  TSP_consumer_status_t
 Status for a futur get_last_error function. More...


Functions

int TSP_consumer_init (int *argc, char **argv[])
 Initialisation for TSP library.

void TSP_consumer_end ()
 End of TSP library use call this function when you are done with the librairy.

void TSP_consumer_connect_all (const char *host_name, TSP_provider_t **providers, int *nb_providers)
 Connects to all found providers on the given host.

void TSP_consumer_disconnect_all (TSP_provider_t providers[])
 Disconnected all found providers.

TSP_provider_tTSP_consumer_connect_url (const char *url)
const char * TSP_consumer_get_connected_name (TSP_provider_t provider)
 Request provider name.

void TSP_consumer_disconnect_one (TSP_provider_t provider)
 Disconnect one given provider.

int TSP_consumer_request_open (TSP_provider_t provider, int custom_argc, char *custom_argv[])
 Ask the provider for a new consumer session.

int TSP_consumer_request_close (TSP_provider_t provider)
 Close the session.

int TSP_consumer_request_information (TSP_provider_t provider)
 Request provider information.

const TSP_consumer_information_tTSP_consumer_get_information (TSP_provider_t provider)
 Retrieve the provider list.

int TSP_consumer_request_sample (TSP_provider_t provider, TSP_consumer_symbol_requested_list_t *symbols)
 Ask the provider for a list of symbols.

const TSP_consumer_symbol_requested_list_t * TSP_consumer_get_requested_sample (TSP_provider_t provider)
 Retrieve the symbols requested list.

int TSP_consumer_request_sample_init (TSP_provider_t provider, TSP_sample_callback_t callback, void *user_data)
 Prepare and start the sampling sequence.

int TSP_consumer_request_sample_destroy (TSP_provider_t provider)
 Stop and destroy the sampling sequence.

int TSP_consumer_read_sample (TSP_provider_t provider, TSP_sample_t *sample, int *new_sample)
 Read a sample symbol.


Detailed Description

Id
tsp_consumer.h,v 1.19 2004/11/09 22:33:01 erk Exp

-----------------------------------------------------------------------

TSP Library - core components for a generic Transport Sampling Protocol.

Copyright (c) 2002 Yves DUFRENNE, Stephane GALLES, Eric NOULARD and Robert PAGNOT

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

-----------------------------------------------------------------------

Project : TSP Maintainer : tsp@astrium.eads.net Component : Consumer

-----------------------------------------------------------------------

Purpose : Main interface for the TSP consumer library

-----------------------------------------------------------------------

Definition in file tsp_consumer.h. Framework Home Page.


Beware !! TSP wave is coming...