Oracle® Fusion Middleware C++ API Reference for Oracle Coherence
12c (


SingleAddressProvider Class Reference

#include <coherence/net/SingleAddressProvider.hpp>

Inherits Object, and AddressProvider.

List of all members.

Detailed Description

SocketAddressProvider wrapper for a single address dynamically added to this provider.

Wei Lin 2012.06.21
Coherence 12.1.2

Public Types

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

Public Member Functions

virtual void accept ()
 This method should be called by the client immediately after it determines that it can successfully use an address returned by the getNextAddress method.
getNextAddress ()
 Obtain a next available address to use.

If the caller can successfully use the returned address (e.g. a connection was established), it should call the AddressProvider's accept()

the next available address or NULL if the list of available addresses was exhausted

virtual void reject (Exception::Holder oheCause)
 This method should be called by the client immediately after it determines that an attempt to use an address returned by the getNextAddress method has failed.

oheCause (optional) an exception that carries the reason why the the caller rejected the previously returned address

virtual void toStream (std::ostream &out) const
 Output a human-readable description of this Object to the given stream.

coherence::lang::operator<<(std::ostream, Object::View) is defined and will call into the toStream method, to output Objects. If a managed String object is desired, the COH_TO_STRING macro can be used to build up a String from streamable contents.

 Object::View vKey   = ...
 Object::View vValue = ...
 std::cout << vKey << " = " << vValue << std::endl;

 String::Handle hs = COH_TO_STRING(vKey << " = " << vValue);

out the stream used to output the description

Protected Member Functions

 SingleAddressProvider (InetSocketAddress::View address)
 Set the InetSocketAddress for this AddressProvider.

Protected Attributes

< InetSocketAddress
 The InetSocketAddress returned by this AddressProvider.
bool m_fAddressGiven
 Whether the InetSocketAddress has already been returned.

Constructor & Destructor Documentation

SingleAddressProvider ( InetSocketAddress::View  address  )  [protected]

Set the InetSocketAddress for this AddressProvider.

address the address which will be returned by this InetSocketAddress

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