ACE_Oneshot_Acceptor< SVC_HANDLER, > Class Template Reference
Generic factory for passively connecting clients and creating exactly one service handler (SVC_HANDLER). More...
#include <Acceptor.h>
Public Types | |
| typedef ACE_PEER_ACCEPTOR_ADDR | addr_type |
| typedef ACE_PEER_ACCEPTOR | acceptor_type |
| typedef SVC_HANDLER | handler_type |
| typedef SVC_HANDLER::stream_type | stream_type |
Public Member Functions | |
| ACE_Oneshot_Acceptor (void) | |
| Constructor. | |
| ACE_Oneshot_Acceptor (const ACE_PEER_ACCEPTOR_ADDR &local_addr, ACE_Reactor *reactor=ACE_Reactor::instance(), ACE_Concurrency_Strategy< SVC_HANDLER > *=0) | |
| int | open (const ACE_PEER_ACCEPTOR_ADDR &, ACE_Reactor *reactor=ACE_Reactor::instance(), ACE_Concurrency_Strategy< SVC_HANDLER > *=0) |
| virtual | ~ACE_Oneshot_Acceptor (void) |
| Close down the {Oneshot_Acceptor}. | |
| virtual int | accept (SVC_HANDLER *=0, ACE_PEER_ACCEPTOR_ADDR *remote_addr=0, const ACE_Synch_Options &synch_options=ACE_Synch_Options::defaults, int restart=1, int reset_new_handle=0) |
| virtual int | cancel (void) |
| Cancel a oneshot acceptor that was started asynchronously. | |
| virtual | operator ACE_PEER_ACCEPTOR & () const |
| Return the underlying {PEER_ACCEPTOR} object. | |
| virtual ACE_PEER_ACCEPTOR & | acceptor (void) const |
| Return the underlying {PEER_ACCEPTOR} object. | |
| virtual int | close (void) |
| Close down the {Oneshot_Acceptor}. | |
| void | dump (void) const |
| Dump the state of an object. | |
Public Attributes | |
| ACE_ALLOC_HOOK_DECLARE | |
| Declare the dynamic allocation hooks. | |
Protected Member Functions | |
| virtual int | activate_svc_handler (SVC_HANDLER *svc_handler) |
| int | shared_accept (SVC_HANDLER *svc_handler, ACE_PEER_ACCEPTOR_ADDR *remote_addr, ACE_Time_Value *timeout, int restart, int reset_new_handle) |
| virtual ACE_HANDLE | get_handle (void) const |
| Returns the listening acceptor's {ACE_HANDLE}. | |
| virtual int | handle_close (ACE_HANDLE=ACE_INVALID_HANDLE, ACE_Reactor_Mask=ACE_Event_Handler::ALL_EVENTS_MASK) |
| virtual int | handle_input (ACE_HANDLE) |
| virtual int | handle_timeout (const ACE_Time_Value &tv, const void *arg) |
| Called when an acceptor times out... | |
| virtual int | init (int argc, ACE_TCHAR *argv[]) |
| virtual int | fini (void) |
| virtual int | info (ACE_TCHAR **, size_t) const |
| Default version returns address info in {buf}. | |
| virtual int | suspend (void) |
| virtual int | resume (void) |
Private Member Functions | |
| int | register_handler (SVC_HANDLER *svc_handler, const ACE_Synch_Options &options, int restart) |
Private Attributes | |
| SVC_HANDLER * | svc_handler_ |
| Hold the svc_handler_ across asynchrony boundaries. | |
| int | restart_ |
| Hold the restart flag across asynchrony boundaries. | |
| ACE_PEER_ACCEPTOR | peer_acceptor_ |
| Factory that establishes connections passively. | |
| ACE_Concurrency_Strategy < SVC_HANDLER > * | concurrency_strategy_ |
| Concurrency strategy for an Acceptor. | |
| bool | delete_concurrency_strategy_ |
Detailed Description
template<class SVC_HANDLER, ACE_PEER_ACCEPTOR_1>
class ACE_Oneshot_Acceptor< SVC_HANDLER, >
Generic factory for passively connecting clients and creating exactly one service handler (SVC_HANDLER).
This class works similarly to the regular {ACE_Acceptor}, with the following differences: 1. This class doesn't automagically register {this} with the {ACE_Reactor} since it expects to have its {accept} method called directly. However, it stashes the {ACE_Reactor} pointer away in case it's needed later to finish accepting a connection asynchronously. 2. The class doesn't need an {ACE_Creation_Strategy} (since the user supplies the SVC_HANDLER) or an {ACE_Accept_Strategy} (since this class only accepts one connection and then removes all traces of itself from the {ACE_Reactor} if it was registered for asynchronous accepts).
Member Typedef Documentation
| typedef ACE_PEER_ACCEPTOR_ADDR ACE_Oneshot_Acceptor< SVC_HANDLER, >::addr_type |
| typedef ACE_PEER_ACCEPTOR ACE_Oneshot_Acceptor< SVC_HANDLER, >::acceptor_type |
| typedef SVC_HANDLER ACE_Oneshot_Acceptor< SVC_HANDLER, >::handler_type |
| typedef SVC_HANDLER::stream_type ACE_Oneshot_Acceptor< SVC_HANDLER, >::stream_type |
Constructor & Destructor Documentation
| ACE_Oneshot_Acceptor< SVC_HANDLER, >::ACE_Oneshot_Acceptor | ( | void | ) | [inline] |
Constructor.
| ACE_Oneshot_Acceptor< SVC_HANDLER, >::ACE_Oneshot_Acceptor | ( | const ACE_PEER_ACCEPTOR_ADDR & | local_addr, | |
| ACE_Reactor * | reactor = ACE_Reactor::instance (), |
|||
| ACE_Concurrency_Strategy< SVC_HANDLER > * | cs = 0 | |||
| ) | [inline] |
Initialize the appropriate strategies for concurrency and then open the {peer_acceptor} at the designated {local_addr}. Note that unlike the {ACE_Acceptor} and {ACE_Strategy_Acceptor}, this method does NOT register {this} acceptor with the {reactor} at this point -- it just stashes the {reactor} away in case it's needed later.
| ACE_Oneshot_Acceptor< SVC_HANDLER, >::~ACE_Oneshot_Acceptor | ( | void | ) | [inline, virtual] |
Close down the {Oneshot_Acceptor}.
Member Function Documentation
| int ACE_Oneshot_Acceptor< SVC_HANDLER, >::open | ( | const ACE_PEER_ACCEPTOR_ADDR & | local_addr, | |
| ACE_Reactor * | reactor = ACE_Reactor::instance (), |
|||
| ACE_Concurrency_Strategy< SVC_HANDLER > * | con_s = 0 | |||
| ) | [inline] |
Initialize the appropriate strategies for concurrency and then open the {peer_acceptor} at the designated {local_addr}. Note that unlike the {ACE_Acceptor} and {ACE_Strategy_Acceptor}, this method does NOT register {this} acceptor with the {reactor} at this point -- it just stashes the {reactor} away in case it's needed later.
| int ACE_Oneshot_Acceptor< SVC_HANDLER, >::accept | ( | SVC_HANDLER * | svc_handler = 0, |
|
| ACE_PEER_ACCEPTOR_ADDR * | remote_addr = 0, |
|||
| const ACE_Synch_Options & | synch_options = ACE_Synch_Options::defaults, |
|||
| int | restart = 1, |
|||
| int | reset_new_handle = 0 | |||
| ) | [inline, virtual] |
Create a {SVC_HANDLER}, accept the connection into the {SVC_HANDLER}, and activate the {SVC_HANDLER}.
| int ACE_Oneshot_Acceptor< SVC_HANDLER, >::cancel | ( | void | ) | [inline, virtual] |
Cancel a oneshot acceptor that was started asynchronously.
| ACE_Oneshot_Acceptor< SVC_HANDLER, >::operator ACE_PEER_ACCEPTOR & | ( | ) | const [inline, virtual] |
Return the underlying {PEER_ACCEPTOR} object.
| ACE_PEER_ACCEPTOR & ACE_Oneshot_Acceptor< SVC_HANDLER, >::acceptor | ( | void | ) | const [inline, virtual] |
Return the underlying {PEER_ACCEPTOR} object.
| int ACE_Oneshot_Acceptor< SVC_HANDLER, >::close | ( | void | ) | [inline, virtual] |
Close down the {Oneshot_Acceptor}.
| void ACE_Oneshot_Acceptor< SVC_HANDLER, >::dump | ( | void | ) | const [inline] |
Dump the state of an object.
| int ACE_Oneshot_Acceptor< SVC_HANDLER, >::activate_svc_handler | ( | SVC_HANDLER * | svc_handler | ) | [inline, protected, virtual] |
Bridge method for activating a {svc_handler} with the appropriate concurrency strategy. Default behavior is to activate the {SVC_HANDLER} as a "passive object." However, subclasses can override this strategy to do more sophisticated concurrency activations (such as creating the {SVC_HANDLER} as an "active object" via multi-threading or multi-processing).
| int ACE_Oneshot_Acceptor< SVC_HANDLER, >::shared_accept | ( | SVC_HANDLER * | svc_handler, | |
| ACE_PEER_ACCEPTOR_ADDR * | remote_addr, | |||
| ACE_Time_Value * | timeout, | |||
| int | restart, | |||
| int | reset_new_handle | |||
| ) | [inline, protected] |
Factors out the code shared between the {accept} and {handle_input} methods.
| ACE_HANDLE ACE_Oneshot_Acceptor< SVC_HANDLER, >::get_handle | ( | void | ) | const [inline, protected, virtual] |
| int ACE_Oneshot_Acceptor< SVC_HANDLER, >::handle_close | ( | ACE_HANDLE | = ACE_INVALID_HANDLE, |
|
| ACE_Reactor_Mask | = ACE_Event_Handler::ALL_EVENTS_MASK | |||
| ) | [inline, protected, virtual] |
Perform termination activities when {this} is removed from the {reactor}.
Reimplemented from ACE_Event_Handler.
| int ACE_Oneshot_Acceptor< SVC_HANDLER, >::handle_input | ( | ACE_HANDLE | ) | [inline, protected, virtual] |
Accept one connection from a client and activates the SVC_HANDLER.
Reimplemented from ACE_Event_Handler.
| int ACE_Oneshot_Acceptor< SVC_HANDLER, >::handle_timeout | ( | const ACE_Time_Value & | tv, | |
| const void * | arg | |||
| ) | [inline, protected, virtual] |
| int ACE_Oneshot_Acceptor< SVC_HANDLER, >::init | ( | int | argc, | |
| ACE_TCHAR * | argv[] | |||
| ) | [inline, protected, virtual] |
Default version does no work and returns -1. Must be overloaded by application developer to do anything meaningful.
Reimplemented from ACE_Shared_Object.
| int ACE_Oneshot_Acceptor< SVC_HANDLER, >::fini | ( | void | ) | [inline, protected, virtual] |
Default version does no work and returns -1. Must be overloaded by application developer to do anything meaningful.
Reimplemented from ACE_Shared_Object.
| int ACE_Oneshot_Acceptor< SVC_HANDLER, >::info | ( | ACE_TCHAR ** | strp, | |
| size_t | length | |||
| ) | const [inline, protected, virtual] |
| int ACE_Oneshot_Acceptor< SVC_HANDLER, >::suspend | ( | void | ) | [inline, protected, virtual] |
Default version does no work and returns -1. Must be overloaded by application developer to do anything meaningful.
Reimplemented from ACE_Service_Object.
| int ACE_Oneshot_Acceptor< SVC_HANDLER, >::resume | ( | void | ) | [inline, protected, virtual] |
Default version does no work and returns -1. Must be overloaded by application developer to do anything meaningful.
Reimplemented from ACE_Service_Object.
| int ACE_Oneshot_Acceptor< SVC_HANDLER, >::register_handler | ( | SVC_HANDLER * | svc_handler, | |
| const ACE_Synch_Options & | options, | |||
| int | restart | |||
| ) | [inline, private] |
Insert ourselves into the {ACE_Reactor} so that we can continue accepting this connection asynchronously. This method should NOT be called by developers directly.
Member Data Documentation
| ACE_Oneshot_Acceptor< SVC_HANDLER, >::ACE_ALLOC_HOOK_DECLARE |
Declare the dynamic allocation hooks.
SVC_HANDLER* ACE_Oneshot_Acceptor< SVC_HANDLER, >::svc_handler_ [private] |
Hold the svc_handler_ across asynchrony boundaries.
int ACE_Oneshot_Acceptor< SVC_HANDLER, >::restart_ [private] |
Hold the restart flag across asynchrony boundaries.
ACE_PEER_ACCEPTOR ACE_Oneshot_Acceptor< SVC_HANDLER, >::peer_acceptor_ [private] |
Factory that establishes connections passively.
ACE_Concurrency_Strategy<SVC_HANDLER>* ACE_Oneshot_Acceptor< SVC_HANDLER, >::concurrency_strategy_ [private] |
Concurrency strategy for an Acceptor.
bool ACE_Oneshot_Acceptor< SVC_HANDLER, >::delete_concurrency_strategy_ [private] |
true if Acceptor created the concurrency strategy and thus should delete it, else false.
The documentation for this class was generated from the following files:
