server/dep/acelite/ace/DEV_Connector.h
2023-01-01 00:55:45 +00:00

110 lines
3.9 KiB
C++

/* -*- C++ -*- */
//=============================================================================
/**
* @file DEV_Connector.h
*
* $Id: DEV_Connector.h 96985 2013-04-11 15:50:32Z huangh $
*
* @author Gerhard Lenzer and Douglas C. Schmidt <schmidt@cs.wustl.edu>
*/
//=============================================================================
#ifndef ACE_DEV_CONNECTOR_H
#define ACE_DEV_CONNECTOR_H
#include /**/ "ace/pre.h"
#include "ace/DEV_IO.h"
#include "ace/Log_Category.h"
#include "ace/os_include/os_fcntl.h"
#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
ACE_BEGIN_VERSIONED_NAMESPACE_DECL
/**
* @class ACE_DEV_Connector
*
* @brief Defines an active connection factory for the ACE_DEV wrappers.
*/
class ACE_Export ACE_DEV_Connector
{
public:
/// Default constructor.
ACE_DEV_Connector (void);
/**
* Actively connect and produce a @a new_io if things go well.
* The @a remote_sap is the address that we are trying to connect
* with. The @a timeout is the amount of time to wait to connect.
* If it's 0 then we block indefinitely. If *timeout == {0, 0} then
* the connection is done using non-blocking mode. In this case, if
* the connection can't be made immediately the value of -1 is
* returned with @c errno == EWOULDBLOCK. If *timeout > {0, 0} then
* this is the maximum amount of time to wait before timing out. If the
* time expires before the connection is made @c errno == ETIME. The
* @a local_sap is the value of local address to bind to. If it's
* the default value of ACE_Addr::sap_any then the user is letting
* the OS do the binding. If @a reuse_addr == 1 then the
* <local_addr> is reused, even if it hasn't been cleanedup yet.
* The @a flags and @a perms arguments are passed down to the <open>
* method.
*/
ACE_DEV_Connector (ACE_DEV_IO &new_io,
const ACE_DEV_Addr &remote_sap,
ACE_Time_Value *timeout = 0,
const ACE_Addr &local_sap = ACE_Addr::sap_any,
int reuse_addr = 0,
int flags = O_RDWR,
int perms = 0);
/**
* Actively connect and produce a @a new_io if things go well.
* The @a remote_sap is the address that we are trying to connect
* with. The @a timeout is the amount of time to wait to connect.
* If it's 0 then we block indefinitely. If *timeout == {0, 0} then
* the connection is done using non-blocking mode. In this case, if
* the connection can't be made immediately the value of -1 is
* returned with @c errno == EWOULDBLOCK. If *timeout > {0, 0} then
* this is the maximum amount of time to wait before timing out. If the
* time expires before the connection is made @c errno == ETIME. The
* @a local_sap is the value of local address to bind to. If it's
* the default value of ACE_Addr::sap_any then the user is letting
* the OS do the binding. If @a reuse_addr == 1 then the
* <local_addr> is reused, even if it hasn't been cleanedup yet.
* The @a flags and @a perms arguments are passed down to the <open>
* method.
*/
int connect (ACE_DEV_IO &new_io,
const ACE_DEV_Addr &remote_sap,
ACE_Time_Value *timeout = 0,
const ACE_Addr &local_sap = ACE_Addr::sap_any,
int reuse_addr = 0,
int flags = O_RDWR,
int perms = 0);
/// Resets any event associations on this handle
bool reset_new_handle (ACE_HANDLE handle);
/// Dump the state of an object.
void dump (void) const;
/// Declare the dynamic allocation hooks.
ACE_ALLOC_HOOK_DECLARE;
// = Meta-type info
typedef ACE_DEV_Addr PEER_ADDR;
typedef ACE_DEV_IO PEER_STREAM;
};
ACE_END_VERSIONED_NAMESPACE_DECL
#if defined (__ACE_INLINE__)
#include "ace/DEV_Connector.inl"
#endif /* __ACE_INLINE__ */
#include /**/ "ace/post.h"
#endif /* ACE_DEV_CONNECTOR_H */