Ice 3.7 C++11 API Reference
Public Member Functions | List of all members
IceGrid::ReplicaGroupFilter Class Referenceabstract

The ReplicaGroupFilter is used by IceGrid to filter adapters returned to the client when it resolves a filtered replica group. More...

#include <IceGrid/IceGrid.h>

Public Member Functions

virtual ::Ice::StringSeq filter (const ::std::string &replicaGroupId, const ::Ice::StringSeq &adapterIds, const ::std::shared_ptr<::Ice::Connection > &con, const ::Ice::Context &ctx)=0
 Filter the the given set of adapters. More...
 
virtual Ice::StringSeq filter (const string &replicaGroupId, const Ice::StringSeq &adapterIds, const Ice::ConnectionPtr &connection, const Ice::Context &context)=0
 Called by the registry to filter a collection of adapters. More...
 
virtual ~ReplicaGroupFilter ()
 

Detailed Description

The ReplicaGroupFilter is used by IceGrid to filter adapters returned to the client when it resolves a filtered replica group.

Abstract base class for a replica group filter.

IceGrid provides the list of available adapters. The implementation of this method can use the provided context and connection to filter and return the filtered set of adapters.

Constructor & Destructor Documentation

◆ ~ReplicaGroupFilter()

virtual IceGrid::ReplicaGroupFilter::~ReplicaGroupFilter ( )
virtual

Member Function Documentation

◆ filter() [1/2]

virtual ::Ice::StringSeq IceGrid::ReplicaGroupFilter::filter ( const ::std::string &  replicaGroupId,
const ::Ice::StringSeq adapterIds,
const ::std::shared_ptr<::Ice::Connection > &  con,
const ::Ice::Context ctx 
)
pure virtual

Filter the the given set of adapters.

Parameters
replicaGroupIdThe replica group ID.
adapterIdsThe adpater IDs to filter.
conThe connection from the Ice client which is resolving the replica group endpoints.
ctxThe context from the Ice client which is resolving the replica group endpoints.
Returns
The filtered adapter IDs.

◆ filter() [2/2]

virtual Ice::StringSeq IceGrid::ReplicaGroupFilter::filter ( const string &  replicaGroupId,
const Ice::StringSeq adapterIds,
const Ice::ConnectionPtr &  connection,
const Ice::Context context 
)
pure virtual

Called by the registry to filter a collection of adapters.

The implementation must not block.

Parameters
replicaGroupIdThe replica group identifier involved in this request.
adapterIdsA sequence of object adapter identifiers denoting the object adapters participating in the replica group whose nodes are active at the time of the request.
connectionThe incoming connection from the client to the registry.
contextThe incoming connection from the client to the registry.
Returns
The filtered list of adapter identifiers.

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