NetFeed Class Reference

#include <OnixS/CME/ConflatedUDP/Feed.h>

Public Member Functions
	NetFeed ()
	~NetFeed ()
const NetFeedId &	id () const
void	id (const NetFeedId &id)
NetFeedType::Enum	type () const
void	type (NetFeedType::Enum type)
NetFeedRole::Enum	role () const
void	role (NetFeedRole::Enum role)
NetFeedConnection &	connection ()
const NetFeedConnection &	connection () const
const TimeSpan &	expirationTime () const
void	expirationTime (UInt32 expirationTime)
const TimeSpan &	receiveTimeout () const
void	receiveTimeout (UInt32 timeInterval)
NetFeedState::Enum	state () const
void	listener (NetFeedListener &listener)
NetFeedConsumer *	consumer () const
void	consumer (NetFeedConsumer &consumer)
void	link (NetFeedLink &link)
ONIXS_CONFLATEDUDP_EXPORTED bool	connect (UInt32)
ONIXS_CONFLATEDUDP_EXPORTED bool	disconnect ()
void	sendMessage (const void *message, size_t length, UInt32 timeout)

Detailed Description

Definition at line 60 of file Feed.h.

Constructor & Destructor Documentation

NetFeed ( )

inline

Initializes the instance.

Definition at line 92 of file Feed.h.

~NetFeed ( )

inline

Definition at line 101 of file Feed.h.

Member Function Documentation

ONIXS_CONFLATEDUDP_EXPORTED bool connect

(

UInt32

)

Bring the given instance to the connected state.

Feed must be fully configured and a valid instance of the NetFeedLink bound to the feed. Otherwise, an exception will be thrown.

Returns 'true' if the feed was connected. 'False' is returned if the feed wasn't in the disconnected state at the moment of invocation.

NetFeedConnection& connection ( )

inline

Connection attributes (overload for modifications).

Definition at line 154 of file Feed.h.

const NetFeedConnection& connection ( ) const

inline

Connection attributes (read-only access).

Definition at line 162 of file Feed.h.

NetFeedConsumer* consumer ( ) const

inline

An instance of data consumer associated with the given feed if available.

Definition at line 242 of file Feed.h.

void consumer ( NetFeedConsumer &  consumer )

inline

Binds the given consumer to the feed.

Definition at line 249 of file Feed.h.

ONIXS_CONFLATEDUDP_EXPORTED bool disconnect

(

)

Instructs the feed to stop delivering packets to the associated consumer.

Returns 'true' if the feed was disconnected. 'False' is returned if the feed wasn't previously connected of was in the process of disconnecting.

const TimeSpan& expirationTime ( ) const

inline

Life time for the feed.

If defined, the given time defines time period during which the feed may receive the incoming data and deliver it to the associate consumer. After that, the feed stop receiving the data while staying in the connected state.

Definition at line 176 of file Feed.h.

void expirationTime ( UInt32  expirationTime )

inline

Defines life time for the feed in seconds.

The given attribute defines time period during which the feed may receive the incoming data and deliver it to the associate consumer. After that, the feed stop receiving the data while staying in the connected state.

Definition at line 189 of file Feed.h.

const NetFeedId& id ( ) const

inline

Identifier associated with feed.

Definition at line 112 of file Feed.h.

void id ( const NetFeedId &  id )

inline

Assigns identifier.

Definition at line 119 of file Feed.h.

void link ( NetFeedLink &  link )

inline

Associates the given link with the feed.

Definition at line 263 of file Feed.h.

void listener ( NetFeedListener &  listener )

inline

Binds the given listener to the feed.

Definition at line 229 of file Feed.h.

const TimeSpan& receiveTimeout ( ) const

inline

Maximal time interval between two packets transmitted.

Definition at line 203 of file Feed.h.

void receiveTimeout ( UInt32  timeInterval )

inline

Updates time interval between two packets transmitted.

Definition at line 210 of file Feed.h.

NetFeedRole::Enum role ( ) const

inline

Role in a service (primary, secondary).

Definition at line 140 of file Feed.h.

void role ( NetFeedRole::Enum  role )

inline

Assigns feed service role.

Definition at line 147 of file Feed.h.

void sendMessage ( const void *  message, size_t  length, UInt32  timeout  )

inline

Send the given message to the source from which the feed receives data and delivers to the associated consumer.

Exceptions

the	exception if the operation is not supported or the given message can't be delivered to the destination.

Definition at line 308 of file Feed.h.

NetFeedState::Enum state ( ) const

inline

Indicates current state.

Definition at line 222 of file Feed.h.

NetFeedType::Enum type ( ) const

inline

Type of service (incremental, instrument, etc).

Definition at line 126 of file Feed.h.

void type ( NetFeedType::Enum  type )

inline

Assigns feed service type.

Definition at line 133 of file Feed.h.

---

The documentation for this class was generated from the following file:

• include/OnixS/CME/ConflatedUDP/Feed.h