TAO_ECG_UDP_Sender Class Reference

Send events received from a "local" EC using UDP. NOT THREAD-SAFE. This class connect as a consumer to an EventChannel and forwards the events it receives from that EC using UDP. More...

#include <ECG_UDP_Sender.h>

Inheritance diagram for TAO_ECG_UDP_Sender:

[legend]Collaboration diagram for TAO_ECG_UDP_Sender:

[legend]List of all members.

[NOHEADER]
	~TAO_ECG_UDP_Sender (void)
void	init (RtecEventChannelAdmin::EventChannel_ptr lcl_ec, RtecUDPAdmin::AddrServer_ptr addr_server, TAO_ECG_Refcounted_Endpoint endpoint_rptr)
void	connect (const RtecEventChannelAdmin::ConsumerQOS &sub)
	Connect or reconnect to the EC with the given subscriptions.
void	shutdown (void)
TAO_EC_Servant_Var< TAO_ECG_UDP_Sender >	create (CORBA::Boolean crc=0)
Public Member Functions
int	mtu (CORBA::ULong mtu)
CORBA::ULong	mtu (void) const
int	get_local_addr (ACE_INET_Addr &addr)
	Get the local endpoint used to send the events.
virtual void	disconnect_push_consumer (void)
virtual void	push (const RtecEventComm::EventSet &events)
Protected Member Functions
	TAO_ECG_UDP_Sender (CORBA::Boolean crc=0)
Private Types
typedef TAO_EC_Auto_Command< TAO_ECG_UDP_Sender_Disconnect_Command >	ECG_Sender_Auto_Proxy_Disconnect
Private Member Functions
void	new_connect (const RtecEventChannelAdmin::ConsumerQOS &sub)
void	reconnect (const RtecEventChannelAdmin::ConsumerQOS &sub)
Private Attributes
RtecEventChannelAdmin::ProxyPushSupplier_var	supplier_proxy_
	Proxy used to receive events from the Event Channel.
RtecEventChannelAdmin::EventChannel_var	lcl_ec_
	Event Channel to which we act as a consumer.
RtecUDPAdmin::AddrServer_var	addr_server_
	We query this object to determine where the events should be sent.
TAO_ECG_CDR_Message_Sender	cdr_sender_
	Helper for fragmenting and sending cdr-encoded events using udp.
ECG_Sender_Auto_Proxy_Disconnect	auto_proxy_disconnect_
	Manages our connection to Supplier Proxy.

---

Detailed Description

Send events received from a "local" EC using UDP. NOT THREAD-SAFE. This class connect as a consumer to an EventChannel and forwards the events it receives from that EC using UDP.

Definition at line 103 of file ECG_UDP_Sender.h.

---

Member Typedef Documentation

typedef TAO_EC_Auto_Command<TAO_ECG_UDP_Sender_Disconnect_Command> TAO_ECG_UDP_Sender::ECG_Sender_Auto_Proxy_Disconnect [private]

Definition at line 211 of file ECG_UDP_Sender.h. Referenced by new_connect().

---

Constructor & Destructor Documentation

TAO_BEGIN_VERSIONED_NAMESPACE_DECL TAO_ECG_UDP_Sender::~TAO_ECG_UDP_Sender (  void   )

Definition at line 28 of file ECG_UDP_Sender.cpp. { }

TAO_ECG_UDP_Sender::TAO_ECG_UDP_Sender (  CORBA::Boolean  crc = 0  )  [protected]

Constructor (protected). Clients can create new TAO_ECG_UDP_Sender objects using the static create() method.

---

Member Function Documentation

void TAO_ECG_UDP_Sender::connect (  const RtecEventChannelAdmin::ConsumerQOS &  sub  )

Connect or reconnect to the EC with the given subscriptions. NOTE: if we are already connected to EC and a reconnection is necessary, the EC must have reconnects enabled in order for this method to succeed. Definition at line 61 of file ECG_UDP_Sender.cpp. References ACE_ERROR, RtecEventChannelAdmin::ConsumerQOS::dependencies, CORBA::is_nil(), LM_ERROR, new_connect(), and reconnect(). { if (CORBA::is_nil (this->lcl_ec_.in ())) { //FUZZ: disable check_for_lack_ACE_OS ACE_ERROR ((LM_ERROR, "Error initializing TAO_ECG_UDP_Sender: " "init() has not been called before connect().")); //FUZZ: enable check_for_lack_ACE_OS throw CORBA::INTERNAL (); } if (sub.dependencies.length () == 0) { ACE_ERROR ((LM_ERROR, "TAO_ECG_UDP_Sender::connect(): " "0-length subscriptions argument.")); throw CORBA::INTERNAL (); } if (CORBA::is_nil (this->supplier_proxy_.in ())) { this->new_connect (sub); } else { this->reconnect (sub); } }

TAO_EC_Servant_Var<TAO_ECG_UDP_Sender> TAO_ECG_UDP_Sender::create (  CORBA::Boolean  crc = 0  )  [static]

Create a new TAO_ECG_UDP_Sender object. (Constructor access is restricted to insure that all TAO_ECG_UDP_Sender objects are heap-allocated.)

void TAO_ECG_UDP_Sender::disconnect_push_consumer (  void   )  [virtual]

Invokes shutdown (), which may result in the object being deleted, if refcounting is used to manage its lifetime. Definition at line 142 of file ECG_UDP_Sender.cpp. References TAO_EC_Auto_Command< T >::disallow_command(), and shutdown(). { // Prevent attempts to disconnect. this->auto_proxy_disconnect_.disallow_command (); this->shutdown (); }

int TAO_ECG_UDP_Sender::get_local_addr (  ACE_INET_Addr &  addr  )

Get the local endpoint used to send the events.

void TAO_ECG_UDP_Sender::init (  RtecEventChannelAdmin::EventChannel_ptr  lcl_ec, RtecUDPAdmin::AddrServer_ptr  addr_server, TAO_ECG_Refcounted_Endpoint  endpoint_rptr )

Parameters: lcl_ec  Event Channel to which we will act as a consumer of events. addr_server  Address server used to obtain event type to multicast group mapping. endpoint_rptr  Endpoint for sending udp/multicast messages. Endpoint's dgram must be open! To insure proper resource clean up, if init () is successful, shutdown () must be called when the sender is no longer needed. This is done by disconnect_push_consumer() method. If disconnect_push_consumer() will not be called, it is the responsibility of the user. Furthermore, if shutdown() is not explicitly called by either disconnect_push_consumer () or the user, the sender will clean up the resources in its destructor, however, certain entities involved in cleanup must still exist at that point, e.g., POA. Definition at line 33 of file ECG_UDP_Sender.cpp. References ACE_ERROR, cdr_sender_, TAO_ECG_CDR_Message_Sender::init(), CORBA::is_nil(), LM_ERROR, and TAO_ECG_Refcounted_Endpoint. { if (CORBA::is_nil (lcl_ec)) { ACE_ERROR ((LM_ERROR, "TAO_ECG_UDP_Sender::init(): " "<lcl_ec> argument is nil.")); throw CORBA::INTERNAL (); } if (CORBA::is_nil (addr_server)) { ACE_ERROR ((LM_ERROR, "TAO_ECG_UDP_Sender::init(): " "address server argument is nil.")); throw CORBA::INTERNAL (); } this->cdr_sender_.init (endpoint_rptr); this->lcl_ec_ = RtecEventChannelAdmin::EventChannel::_duplicate (lcl_ec); this->addr_server_ = RtecUDPAdmin::AddrServer::_duplicate (addr_server); }

CORBA::ULong TAO_ECG_UDP_Sender::mtu (  void   )  const

The sender may need to fragment the message, otherwise the network may drop the packets. Setting the MTU can fail if the value is too small (at least the header + 8 bytes must fit).

int TAO_ECG_UDP_Sender::mtu (  CORBA::ULong  mtu  )

The sender may need to fragment the message, otherwise the network may drop the packets. Setting the MTU can fail if the value is too small (at least the header + 8 bytes must fit).

void TAO_ECG_UDP_Sender::new_connect (  const RtecEventChannelAdmin::ConsumerQOS &  sub  )  [private]

Definition at line 91 of file ECG_UDP_Sender.cpp. References activate(), ECG_Sender_Auto_Proxy_Disconnect, TAO_EC_Auto_Command< T >::set_command(), and TAO_EC_Deactivated_Object::set_deactivator(). Referenced by connect(). { // Activate with poa. RtecEventComm::PushConsumer_var consumer_ref; PortableServer::POA_var poa = this->_default_POA (); TAO_EC_Object_Deactivator deactivator; activate (consumer_ref, poa.in (), this, deactivator); // Connect as a consumer to the local EC. RtecEventChannelAdmin::ConsumerAdmin_var consumer_admin = this->lcl_ec_->for_consumers (); RtecEventChannelAdmin::ProxyPushSupplier_var proxy = consumer_admin->obtain_push_supplier (); ECG_Sender_Auto_Proxy_Disconnect new_proxy_disconnect (proxy.in ()); proxy->connect_push_consumer (consumer_ref.in (), sub); // Update resource managers. this->supplier_proxy_ = proxy._retn (); this->auto_proxy_disconnect_.set_command (new_proxy_disconnect); this->set_deactivator (deactivator); }

void TAO_ECG_UDP_Sender::push (  const RtecEventComm::EventSet &  events  )  [virtual]

Invokes shutdown (), which may result in the object being deleted, if refcounting is used to manage its lifetime. Definition at line 166 of file ECG_UDP_Sender.cpp. References cdr_sender_, RtecEventComm::Event::data, RtecEventComm::EventSet, RtecEventComm::Event::header, RtecUDPAdmin::UDP_Addr::ipaddr, RtecUDPAdmin::UDP_Addr::port, TAO_ECG_CDR_Message_Sender::send_message(), RtecEventComm::EventHeader::ttl, and ACE_OutputCDR::write_ulong(). { if (events.length () == 0) { // ACE_DEBUG ((EC_FORMAT (DEBUG, // "Nothing to multicast: " // "0-length EventSet."))); return; } // Send each event in a separate message. // @@ TODO It is interesting to group events destined to the // same mcast group in a single message. for (u_int i = 0; i < events.length (); ++i) { // To avoid loops we keep a TTL field on the events and skip the // events with TTL <= 0 if (events[i].header.ttl <= 0) continue; const RtecEventComm::Event& e = events[i]; // We need to modify the TTL field, but copying the entire event // would be wasteful; instead we create a new header and only // modify the header portion. RtecEventComm::EventHeader header = e.header; header.ttl--; // Start building the message TAO_OutputCDR cdr; // Marshal as if it was a sequence of one element, notice how we // marshal a modified version of the header, but the payload is // marshal without any extra copies. cdr.write_ulong (1); if (!(cdr << header) || !(cdr << e.data)) throw CORBA::MARSHAL (); ACE_INET_Addr inet_addr; try { // Grab the right mcast group for this event... RtecUDPAdmin::UDP_Address_var udp_addr; this->addr_server_->get_address (header, udp_addr.out()); switch (udp_addr->_d()) { case RtecUDPAdmin::Rtec_inet: inet_addr.set(udp_addr->v4_addr().port, udp_addr->v4_addr().ipaddr); break; case RtecUDPAdmin::Rtec_inet6: #if defined (ACE_HAS_IPV6) inet_addr.set_type(PF_INET6); #endif inet_addr.set_address(udp_addr->v6_addr().ipaddr,16,0); inet_addr.set_port_number(udp_addr->v6_addr().port); break; } } catch (const ::CORBA::BAD_OPERATION &) { // server only supports IPv4 // Grab the right mcast group for this event... RtecUDPAdmin::UDP_Addr udp_addr; this->addr_server_->get_addr (header, udp_addr); inet_addr.set (udp_addr.port, udp_addr.ipaddr); } this->cdr_sender_.send_message (cdr, inet_addr); } }

void TAO_ECG_UDP_Sender::reconnect (  const RtecEventChannelAdmin::ConsumerQOS &  sub  )  [private]

Definition at line 121 of file ECG_UDP_Sender.cpp. References CORBA::is_nil(). Referenced by connect(). { // Obtain our object reference from the POA. RtecEventComm::PushConsumer_var consumer_ref; PortableServer::POA_var poa = this->_default_POA (); CORBA::Object_var obj = poa->servant_to_reference (this); consumer_ref = RtecEventComm::PushConsumer::_narrow (obj.in ()); if (CORBA::is_nil (consumer_ref.in ())) { throw CORBA::INTERNAL (); } // Reconnect. this->supplier_proxy_->connect_push_consumer (consumer_ref.in (), sub); }

void TAO_ECG_UDP_Sender::shutdown (  void   )

Calling this method may result in decrementing of the reference count (due to deactivation) and deletion of the object. Definition at line 151 of file ECG_UDP_Sender.cpp. References cdr_sender_, TAO_EC_Object_Deactivator::deactivate(), TAO_EC_Auto_Command< T >::execute(), and TAO_ECG_CDR_Message_Sender::shutdown(). Referenced by disconnect_push_consumer(). { this->supplier_proxy_ = RtecEventChannelAdmin::ProxyPushSupplier::_nil (); this->auto_proxy_disconnect_.execute (); this->addr_server_ = RtecUDPAdmin::AddrServer::_nil (); this->lcl_ec_ = RtecEventChannelAdmin::EventChannel::_nil (); this->deactivator_.deactivate (); this->cdr_sender_.shutdown (); }

---

Member Data Documentation

RtecUDPAdmin::AddrServer_var TAO_ECG_UDP_Sender::addr_server_ [private]

We query this object to determine where the events should be sent. Definition at line 205 of file ECG_UDP_Sender.h.

ECG_Sender_Auto_Proxy_Disconnect TAO_ECG_UDP_Sender::auto_proxy_disconnect_ [private]

Manages our connection to Supplier Proxy. Definition at line 213 of file ECG_UDP_Sender.h.

TAO_ECG_CDR_Message_Sender TAO_ECG_UDP_Sender::cdr_sender_ [private]

Helper for fragmenting and sending cdr-encoded events using udp. Definition at line 208 of file ECG_UDP_Sender.h. Referenced by init(), push(), and shutdown().

RtecEventChannelAdmin::EventChannel_var TAO_ECG_UDP_Sender::lcl_ec_ [private]

Event Channel to which we act as a consumer. Definition at line 202 of file ECG_UDP_Sender.h.

RtecEventChannelAdmin::ProxyPushSupplier_var TAO_ECG_UDP_Sender::supplier_proxy_ [private]

Proxy used to receive events from the Event Channel. Definition at line 199 of file ECG_UDP_Sender.h.

---

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

• ECG_UDP_Sender.h
• ECG_UDP_Sender.cpp

---