TSP: The Transport Sample Protocol



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

tsp_stream_sender.h File Reference

#include "tsp_prjcfg.h"
#include "tsp_ringbuf.h"

Go to the source code of this file.

Defines

#define TSP_STREAM_SENDER_ITEM_BUF(stream_sender_item)   ((char*)( (stream_sender_item) + 1 ))
 Get the memory following a TSP_stream_sender_item_t item.


Functions

 RINGBUF_DECLARE_TYPE_DYNAMIC (TSP_stream_sender_ringbuf_t, TSP_stream_sender_item_t)
 samples ring buf

TSP_stream_sender_t TSP_stream_sender_create (int fifo_size, int buffer_size)
 Create a stream sender.

void TSP_stream_sender_stop (TSP_stream_sender_t sender)
 Stop the stream sender.

void TSP_stream_sender_destroy (TSP_stream_sender_t sender)
 Destroy the stream sender.

int TSP_stream_sender_send (TSP_stream_sender_t sender, const char *buffer, int bufferLen)
 Send some data on thrue data stream.

const char * TSP_stream_sender_get_data_address_string (TSP_stream_sender_t sender)
 Get the address string to which the client must connect to receive data.(format depends on the used protocol ; for TCP/IP it is 'hostname : port').

int TSP_stream_sender_is_client_connected (TSP_stream_sender_t sender)
 Is the client connected ?

int TSP_stream_sender_is_connection_ok (TSP_stream_sender_t sender)
 Is the client still connected ?

TSP_stream_sender_ringbuf_t * TSP_stream_sender_get_ringbuf (TSP_stream_sender_t sender)
 The ringbuffer object.

TSP_stream_sender_item_t * TSP_stream_sender_get_buffer (TSP_stream_sender_t sender)
 The buffer object.


Detailed Description

Header
/cvsroot/tsp/tsp/src/core/ctrl/tsp_stream_sender.h,v 1.9 2002/12/24 14:14:19 tntdev 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-space.com Component : Provider

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

Purpose : Interface for the low level functions that send the data stream to the consumers.

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

Definition in file tsp_stream_sender.h.


Define Documentation

#define TSP_STREAM_SENDER_ITEM_BUF stream_sender_item   )     ((char*)( (stream_sender_item) + 1 ))
 

Get the memory following a TSP_stream_sender_item_t item.

Definition at line 66 of file tsp_stream_sender.h.

Referenced by TSP_data_sender_send(), and TSP_data_sender_send_msg_ctrl().


Function Documentation

RINGBUF_DECLARE_TYPE_DYNAMIC TSP_stream_sender_ringbuf_t  ,
TSP_stream_sender_item_t 
 

samples ring buf

TSP_stream_sender_t TSP_stream_sender_create int  fifo_size,
int  buffer_size
 

Create a stream sender.

Parameters:
fifo_size Size of ringbuffer. Set fifo_size = 0 if you do not want any ringbuffer
buffer_size Size of buffer used to prepare the data
Returns:
The stream sender handle

Definition at line 278 of file tsp_stream_sender.c.

References TSP_DATA_STREAM_SOCKET_FIFO_SIZE, and TSP_MAXHOSTNAMELEN.

Referenced by TSP_data_sender_create().

void TSP_stream_sender_destroy TSP_stream_sender_t  sender  ) 
 

Destroy the stream sender.

Parameters:
sender The stream sender handle

Definition at line 453 of file tsp_stream_sender.c.

Referenced by TSP_data_sender_destroy().

TSP_stream_sender_item_t* TSP_stream_sender_get_buffer TSP_stream_sender_t  sender  ) 
 

The buffer object.

Parameters:
sender The stream sender handle.
Returns:
The address of the created buffer (meaningful when fifo_size = 0)

Definition at line 567 of file tsp_stream_sender.c.

Referenced by TSP_data_sender_create().

const char* TSP_stream_sender_get_data_address_string TSP_stream_sender_t  sender  ) 
 

Get the address string to which the client must connect to receive data.(format depends on the used protocol ; for TCP/IP it is 'hostname : port').

Parameters:
sender The stream sender handle.
Returns:
data address. An error return 0;

Definition at line 267 of file tsp_stream_sender.c.

Referenced by TSP_data_sender_get_data_address_string().

TSP_stream_sender_ringbuf_t* TSP_stream_sender_get_ringbuf TSP_stream_sender_t  sender  ) 
 

The ringbuffer object.

Parameters:
sender The stream sender handle.
Returns:
The address of the created ringbuf (meaningful when fifo_size > 0)

Definition at line 560 of file tsp_stream_sender.c.

Referenced by TSP_data_sender_create().

int TSP_stream_sender_is_client_connected TSP_stream_sender_t  sender  ) 
 

Is the client connected ?

If a client crashes this still returns TRUE

Returns:
TRUE if the client was connected

Definition at line 545 of file tsp_stream_sender.c.

Referenced by TSP_data_sender_is_consumer_connected().

int TSP_stream_sender_is_connection_ok TSP_stream_sender_t  sender  ) 
 

Is the client still connected ?

Parameters:
sender The stream sender handle. TRUE = client still connected

Definition at line 552 of file tsp_stream_sender.c.

int TSP_stream_sender_send TSP_stream_sender_t  sender,
const char *  buffer,
int  bufferLen
 

Send some data on thrue data stream.

Parameters:
sender The stream sender handle.
buffer The data that must be sent
bufferLen The length of the data in buffer (bytes)
Returns:
TRUE or FALSE. TRUE = OK

Definition at line 498 of file tsp_stream_sender.c.

void TSP_stream_sender_stop TSP_stream_sender_t  sender  ) 
 

Stop the stream sender.

Parameters:
sender The stream sender handle

Definition at line 475 of file tsp_stream_sender.c.

Referenced by TSP_data_sender_stop().

Framework Home Page.


Beware !! TSP wave is coming...