TAO_ECG_UDP_EH Class Reference

Event Handler for UDP messages. More...

#include <ECG_UDP_EH.h>

Inheritance diagram for TAO_ECG_UDP_EH:

Collaboration diagram for TAO_ECG_UDP_EH:

List of all members.

Public Member Functions
virtual int	handle_input (ACE_HANDLE fd)
ACE_SOCK_Dgram &	dgram (void)
	TAO_ECG_UDP_EH (TAO_ECG_Dgram_Handler *recv)
	Initialization and termination methods.
virtual	~TAO_ECG_UDP_EH (void)
	Destructor.
int	open (const ACE_INET_Addr &ipaddr, int reuse_addr=0)
virtual int	shutdown (void)
Public Member Functions inherited from ACE_Event_Handler
virtual	~ACE_Event_Handler (void)
virtual ACE_HANDLE	get_handle (void) const
virtual void	set_handle (ACE_HANDLE)
virtual int	priority (void) const
virtual void	priority (int priority)
virtual int	handle_output (ACE_HANDLE fd=ACE_INVALID_HANDLE)
virtual int	handle_exception (ACE_HANDLE fd=ACE_INVALID_HANDLE)
virtual int	handle_timeout (const ACE_Time_Value &current_time, const void *act=0)
virtual int	handle_exit (ACE_Process *)
virtual int	handle_close (ACE_HANDLE handle, ACE_Reactor_Mask close_mask)
virtual int	handle_signal (int signum, siginfo_t *=0, ucontext_t *=0)
virtual int	resume_handler (void)
virtual int	handle_qos (ACE_HANDLE=ACE_INVALID_HANDLE)
virtual int	handle_group_qos (ACE_HANDLE=ACE_INVALID_HANDLE)
virtual void	reactor (ACE_Reactor *reactor)
virtual ACE_Reactor *	reactor (void) const
virtual ACE_Reactor_Timer_Interface *	reactor_timer_interface (void) const
virtual Reference_Count	add_reference (void)
virtual Reference_Count	remove_reference (void)
Reference_Counting_Policy &	reference_counting_policy (void)
Public Member Functions inherited from TAO_ECG_Handler_Shutdown
virtual	~TAO_ECG_Handler_Shutdown (void)

Private Attributes
ACE_SOCK_Dgram	dgram_
	The datagram used to receive the data.
TAO_ECG_Dgram_Handler *	receiver_
	We callback to this object when a message arrives.

Additional Inherited Members
Public Types inherited from ACE_Event_Handler
typedef long	Reference_Count
Static Public Member Functions inherited from ACE_Event_Handler
static ACE_THR_FUNC_RETURN	read_adapter (void *event_handler)
static int	register_stdin_handler (ACE_Event_Handler *eh, ACE_Reactor *reactor, ACE_Thread_Manager *thr_mgr, int flags=THR_DETACHED)
static int	remove_stdin_handler (ACE_Reactor *reactor, ACE_Thread_Manager *thr_mgr)
Public Attributes inherited from ACE_Event_Handler
	LO_PRIORITY
	HI_PRIORITY
	NULL_MASK
	READ_MASK
	WRITE_MASK
	EXCEPT_MASK
	ACCEPT_MASK
	CONNECT_MASK
	TIMER_MASK
	QOS_MASK
	GROUP_QOS_MASK
	SIGNAL_MASK
	ALL_EVENTS_MASK
	RWE_MASK
	DONT_CALL
	ACE_EVENT_HANDLER_NOT_RESUMED
	ACE_REACTOR_RESUMES_HANDLER
	ACE_APPLICATION_RESUMES_HANDLER
Protected Types inherited from ACE_Event_Handler
typedef ACE_Atomic_Op < ACE_SYNCH_MUTEX, Reference_Count >	Atomic_Reference_Count
Protected Member Functions inherited from ACE_Event_Handler
	ACE_Event_Handler (ACE_Reactor *=0, int priority=ACE_Event_Handler::LO_PRIORITY)
Protected Attributes inherited from ACE_Event_Handler
Atomic_Reference_Count	reference_count_

---

Detailed Description

Event Handler for UDP messages.

Listens for messages on a UDP socket. When there is a message, calls handle_input () on a specified TAO_ECG_Dgram_Handler to inform it about message arrival.

NOT THREAD-SAFE.

---

Constructor & Destructor Documentation

TAO_ECG_UDP_EH::TAO_ECG_UDP_EH

(

TAO_ECG_Dgram_Handler *

recv

)

Initialization and termination methods.

Constructor. Messages received by this EH will be forwarded to the <recv>.

TAO_ECG_UDP_EH::~TAO_ECG_UDP_EH ( void  )

virtual

Destructor.

---

Member Function Documentation

ACE_SOCK_Dgram& TAO_ECG_UDP_EH::dgram

(

void

)

Obtain the dgram, this is one of those "controlled violations of type safety", allowing the user to setup options and gain access to low-level features.

int TAO_ECG_UDP_EH::handle_input ( ACE_HANDLE  fd )

virtual

Main method - reactor callback. Notify <receiver_> that <dgram_> is ready for reading.

Reimplemented from ACE_Event_Handler.

int TAO_ECG_UDP_EH::open	(	const ACE_INET_Addr &	ipaddr,
		int	reuse_addr = 0
	)

Open the datagram and register itself with this->reactor(). To insure proper resource clean up, if open () is successful, the user MUST call shutdown () when handler is no longer needed (and its reactor still exists).

int TAO_ECG_UDP_EH::shutdown ( void  )

virtual

TAO_ECG_Handler_Shutdown method. Unsubscribe from the reactor and close the datagram.

Implements TAO_ECG_Handler_Shutdown.

---

Member Data Documentation

ACE_SOCK_Dgram TAO_ECG_UDP_EH::dgram_

private

The datagram used to receive the data.

TAO_ECG_Dgram_Handler* TAO_ECG_UDP_EH::receiver_

private

We callback to this object when a message arrives.

---

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

• ECG_UDP_EH.h
• ECG_UDP_EH.cpp