diff options
Diffstat (limited to 'TAO/orbsvcs/orbsvcs/Event/EC_Gateway_UDP.h')
| -rw-r--r-- | TAO/orbsvcs/orbsvcs/Event/EC_Gateway_UDP.h | 318 |
1 files changed, 0 insertions, 318 deletions
diff --git a/TAO/orbsvcs/orbsvcs/Event/EC_Gateway_UDP.h b/TAO/orbsvcs/orbsvcs/Event/EC_Gateway_UDP.h deleted file mode 100644 index e5bfe24a4e8..00000000000 --- a/TAO/orbsvcs/orbsvcs/Event/EC_Gateway_UDP.h +++ /dev/null @@ -1,318 +0,0 @@ -/* -*- C++ -*- */ -// $Id$ -// -// ============================================================================ -// -// = LIBRARY -// TAO services -// -// = FILENAME -// EC_Gateway_UDP -// -// = AUTHOR -// Carlos O'Ryan -// -// = DESCRIPTION -// Define helper classes to propagate events between ECs using -// either UDP or multicast. -// The architecture is a bit complicated and deserves some -// explanation: sending the events over UDP (or mcast) is easy, a -// Consumer (TAO_ECG_UDP_Sender) subscribes for a certain set of -// events, its push() method marshalls the event set into a CDR -// stream that is sent using an ACE_SOCK_CODgram. The subscription -// set and IP address can be configured. -// Another helper class (TAO_ECG_UDP_Receiver) acts as a supplier of -// events; it receives a callback when an event is available on an -// ACE_SOCK_Dgram, it demarshalls the event and pushes it to the -// EC. Two ACE_Event_Handler classes are provided that can forward -// the events to this Supplier: TAO_ECG_Mcast_EH can receive events -// from a multicast group; TAO_ECG_UDP_EH can receive events from a -// regular UDP socket. -// -// Matching of the events types carried by a multicast group (or IP -// address) is up to the application. Gateway classes can be -// implemented to automate this: the EC informs its gateways about -// local changes in the subscriptions (for example), the Gateway -// could then consult an administrative server that will inform it -// which multicast groups carry those event types, it can then -// create the proper event handlers and TAO_ECG_Receivers. An -// analogous class can be implemented for the Supplier side. -// -// An alternative approach would be to look the current set of -// multicast groups and the events carried on each, using that -// information a suitable TAO_ECG_UDP_Receiver can be configured -// (and of course the Senders on the client side). -// -// = TODO -// The class makes an extra copy of the events, we need to -// investigate if closer collaboration with its collocated EC could -// be used to remove that copy. -// -// ============================================================================ - -#ifndef TAO_EC_GATEWAY_UDP_H -#define TAO_EC_GATEWAY_UDP_H - -#include "ace/SOCK_CODgram.h" -#include "ace/SOCK_Dgram_Mcast.h" -#include "orbsvcs/RtecEventChannelAdminS.h" -#include "orbsvcs/RtecUDPAdminS.h" -#include "orbsvcs/orbsvcs_export.h" - -class TAO_ORBSVCS_Export TAO_ECG_UDP_Sender : public POA_RtecEventComm::PushConsumer -{ - // - // = TITLE - // Send events received from a "local" EC using UDP. - // - // = DESCRIPTION - // This class connect as a consumer to an EventChannel - // and it sends the events using UDP, the UDP address can be a - // normal IP address or it can be a multicast group. - // The UDP address is obtained from a RtecUDPAdmin::AddrServer - // class. - // It marshalls the events using TAO CDR classes. - // No provisions are taken for message fragmentation. - // -public: - TAO_ECG_UDP_Sender (void); - - int get_local_addr (ACE_INET_Addr& addr); - // Get the local endpoint used to send the events. - - void init (RtecEventChannelAdmin::EventChannel_ptr lcl_ec, - RtecScheduler::Scheduler_ptr lcl_sched, - const char* lcl_name, - RtecUDPAdmin::AddrServer_ptr addr_server, - ACE_SOCK_Dgram* dgram, - CORBA::Environment &_env); - // To do its job this class requires to know the local EC it will - // connect to; it also requires to build an RT_Info for the local - // scheduler. - // It only keeps a copy of its SupplierProxy, used for later - // connection and disconnections. - // @@ TODO part of the RT_Info is hardcoded, we need to make it - // parametric. - - void shutdown (CORBA::Environment&); - // Disconnect and shutdown the sender, no further connections will - // work unless init() is called again. - - void open (RtecEventChannelAdmin::ConsumerQOS& sub, - CORBA::Environment& env); - // Connect (or reconnect) to the EC with the given subscriptions. - - void close (CORBA::Environment& _env); - // Disconnect from the EC, but reconnection is still possible. - - virtual void disconnect_push_consumer (CORBA::Environment &); - virtual void push (const RtecEventComm::EventSet &events, - CORBA::Environment &); - // The PushConsumer methods. - -private: - RtecEventChannelAdmin::EventChannel_var lcl_ec_; - // The remote and the local EC, so we can reconnect when the - // subscription list changes. - - RtecScheduler::handle_t lcl_info_; - // Our local and remote RT_Infos. - - RtecEventChannelAdmin::ProxyPushSupplier_var supplier_proxy_; - // We talk to the EC (as a consumer) using this proxy. - - RtecUDPAdmin::AddrServer_var addr_server_; - // We query this object to determine where are the events sent. - - ACE_SOCK_Dgram *dgram_; - // The datagram used to sendto(), this object is *not* owned by the - // UDP_Sender. -}; - -class TAO_ORBSVCS_Export TAO_ECG_UDP_Receiver : public POA_RtecEventComm::PushSupplier -{ - // - // = TITLE - // Decodes events from an ACE_SOCK_Dgram and pushes them to the - // Event_Channel. - // - // = DESCRIPTION - // This supplier receives events from an ACE_SOCK_Dgram, either - // from a UDP socket or a Mcast group, decodes them and push them - // to the EC. - // No provisions are taken for message reassembly. - // -public: - TAO_ECG_UDP_Receiver (void); - - void init (RtecEventChannelAdmin::EventChannel_ptr lcl_ec, - RtecScheduler::Scheduler_ptr lcl_sched, - const char* lcl_name, - const ACE_INET_Addr& ignore_from, - RtecUDPAdmin::AddrServer_ptr addr_server, - CORBA::Environment &_env); - // To do its job this class requires to know the local EC it will - // connect to; it also requires to build an RT_Info for the local - // scheduler. - // @@ TODO part of the RT_Info is hardcoded, we need to make it - // parametric. - - void shutdown (CORBA::Environment&); - // Disconnect and shutdown the gateway, no further connectsions - - void open (RtecEventChannelAdmin::SupplierQOS& pub, - CORBA::Environment &env); - // Connect to the EC using the given publications lists. - - virtual void close (CORBA::Environment& env); - // Disconnect to the EC. - - int handle_input (ACE_SOCK_Dgram& dgram); - // The Event_Handlers call this method when data is available at the - // socket, the <dgram> must be ready for reading and contain a full - // event. - - // The PushSupplier method. - virtual void disconnect_push_supplier (CORBA::Environment &); - - - void get_addr (const RtecEventComm::EventHeader& header, - RtecUDPAdmin::UDP_Addr_out addr, - CORBA::Environment& env); - // Call the RtecUDPAdmin::AddrServer - -private: - RtecEventChannelAdmin::EventChannel_var lcl_ec_; - // The remote and the local EC, so we can reconnect when the list changes. - - RtecScheduler::handle_t lcl_info_; - // Our RT_Info. - - RtecEventChannelAdmin::ProxyPushConsumer_var consumer_proxy_; - // We talk to the EC (as a consumer) using this proxy. - - ACE_INET_Addr ignore_from_; - // Ignore any events coming from this IP addres. - - RtecUDPAdmin::AddrServer_var addr_server_; -}; - -class TAO_ORBSVCS_Export TAO_ECG_UDP_EH : public ACE_Event_Handler -{ - // - // = TITLE - // Event Handler for UDP messages. - // - // = DESCRIPTION - // This object receives callbacks from the Reactor when data is - // available on a UDP socket, it forwards to the ECG_UDP_Receiver - // which reads the events and transform it into an event. -public: - TAO_ECG_UDP_EH (TAO_ECG_UDP_Receiver *recv); - - int open (const ACE_INET_Addr& ipaddr); - // Open the datagram and register with this->reactor() - - int close (void); - // Close the datagram and unregister with the reactor. - - // Reactor callbacks - virtual int handle_input (ACE_HANDLE fd); - virtual ACE_HANDLE get_handle (void) const; - -private: - ACE_SOCK_Dgram dgram_; - // The datagram used to receive the data. - - TAO_ECG_UDP_Receiver* receiver_; - // We callback to this object when a message arrives. -}; - -class TAO_ORBSVCS_Export TAO_ECG_Mcast_EH : public ACE_Event_Handler -{ - // - // = TITLE - // Event Handler for UDP messages. - // - // = DESCRIPTION - // This object receives callbacks from the Reactor when data is - // available on the mcast socket, it forwards to the UDP_Receive - // gateway which reads the events and transform it into an event. - // -public: - TAO_ECG_Mcast_EH (TAO_ECG_UDP_Receiver *recv); - - int open (RtecEventChannelAdmin::EventChannel_ptr ec, - CORBA::Environment& _env); - // Register for changes in the EC subscription list. - // When the subscription list becomes non-empty we join the proper - // multicast groups (using the receiver to translate between event - // types and mcast groups) and the class registers itself with the - // reactor. - - int close (CORBA::Environment& _env); - // Remove ourselves from the event channel, unsubscribe from the - // multicast groups, close the sockets and unsubscribe from the - // reactor. - - virtual int handle_input (ACE_HANDLE fd); - virtual ACE_HANDLE get_handle (void) const; - // Reactor callbacks - - void update_consumer (const RtecEventChannelAdmin::ConsumerQOS& sub, - CORBA::Environment& _env); - void update_supplier (const RtecEventChannelAdmin::SupplierQOS& pub, - CORBA::Environment& _env); - // The Observer methods - - class Observer : public POA_RtecEventChannelAdmin::Observer - { - // = TITLE - // Observe changes in the EC subscriptions. - // - // = DESCRIPTION - // As the subscriptions on the EC change we also change the - // mcast groups that we join. - // We could use the TIE classes, but they don't work in all - // compilers. - public: - Observer (TAO_ECG_Mcast_EH* eh); - // We report changes in the EC subscriptions to the event - // handler. - - // The Observer methods - virtual void update_consumer (const RtecEventChannelAdmin::ConsumerQOS& sub, - CORBA::Environment& _env); - virtual void update_supplier (const RtecEventChannelAdmin::SupplierQOS& pub, - CORBA::Environment& _env); - - private: - TAO_ECG_Mcast_EH* eh_; - // Our callback object. - }; - -private: - int subscribe (const ACE_INET_Addr &mcast_addr); - int unsubscribe (const ACE_INET_Addr &mcast_addr); - // Control the multicast group subscriptions - -private: - ACE_SOCK_Dgram_Mcast dgram_; - // The datagram used to receive the data. - - TAO_ECG_UDP_Receiver* receiver_; - // We callback to this object when a message arrives. - - Observer observer_; - // This object will call us back when the subscription list - // changes. - - RtecEventChannelAdmin::Observer_Handle handle_; - // Keep the handle of the observer so we can unregister later. - - RtecEventChannelAdmin::EventChannel_var ec_; - // The Event Channel. -}; - - -#endif /* ACE_EVENT_CHANNEL_UDP_H */ |