Oracle Coherence for C++ API
Release 3.7.1.0

E22845-01

ConfigurableAddressProvider::AddressHolder Class Reference

#include <coherence/net/ConfigurableAddressProvider.hpp>

Inherits Object.

List of all members.


Detailed Description

A stateful holder for an InetSocketAddress object.
 

Public Types

typedef spec::Handle Handle
 AddressHolder Handle definition.
typedef spec::View View
 AddressHolder View definition.
typedef spec::Holder Holder
 AddressHolder Holder definition.

Public Member Functions

InetSocketAddress::View getAddress () const
 Obtain the underlying address.

Protected Member Functions

 AddressHolder (String::View vsHost, int32_t nPort)
 Construct an AddressHolder for the specified InetSocketAddress.
 AddressHolder ()
 Create a new AddressHolder instance.
virtual bool isPending () const
 Check whether or not the underlying address has been accepted.
virtual void setPending (bool fPending)
 Set or clear the "pending" flag.
virtual bool isReported () const
 Check whether or not the underlying address has been reported as unresolveable.
virtual void setReported (bool fReported)
 Set of clear the "reported" flag.

Protected Attributes

FinalView< Stringm_vsHost
 The configured address, either hostname or IP address.
const uint16_t m_nPort
 The configured port.
bool m_fPending
 A flag indicating that the underlying address has been provided to a client, but has not yet been accepted.
bool m_fReported
 Specifies if this address has already been reported as unresolved.

Constructor & Destructor Documentation

AddressHolder ( String::View  vsHost,
    int32_t  nPort 
  )    [protected]

Construct an AddressHolder for the specified InetSocketAddress.

Parameters:
 sHost the hostname
 nPort the port number


Member Function Documentation

InetSocketAddress::View getAddress (  )  const

Obtain the underlying address.

Returns:
the underlying InetSocketAddress object

virtual bool isPending (  )  const [protected, virtual]

Check whether or not the underlying address has been accepted.

Returns:
true iff the underlying address has not yet been accepted

virtual void setPending ( bool  fPending  )  [protected, virtual]

Set or clear the "pending" flag.

Parameters:
 fPending the flag value

virtual bool isReported (  )  const [protected, virtual]

Check whether or not the underlying address has been reported as unresolveable.

Returns:
true iff the underlying address has been reported as unresolveable

virtual void setReported ( bool  fReported  )  [protected, virtual]

Set of clear the "reported" flag.

Parameters:
 fReported the flag value


The documentation for this class was generated from the following file:
Copyright © 2000, 2011, Oracle and/or its affiliates. All rights reserved.