Ice 3.7 C++11 API Reference
Public Member Functions | Static Public Member Functions | List of all members
Glacier2::StringSetPrx Class Reference

An object for managing the set of identity constraints for specific parts of object identity on a Session. More...

#include <Glacier2/Glacier2.h>

Inheritance diagram for Glacier2::StringSetPrx:
Inheritance graph
[legend]
Collaboration diagram for Glacier2::StringSetPrx:
Collaboration graph
[legend]

Public Member Functions

void add (const ::Ice::StringSeq &additions, const ::Ice::Context &context=::Ice::noExplicitContext)
 Add a sequence of strings to this set of constraints. More...
 
::std::function< void()> addAsync (const ::Ice::StringSeq &additions, ::std::function< void()> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Add a sequence of strings to this set of constraints. More...
 
template<template< typename > class P = ::std::promise>
auto addAsync (const ::Ice::StringSeq &additions, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< void >>().get_future())
 Add a sequence of strings to this set of constraints. More...
 
::Ice::StringSeq get (const ::Ice::Context &context=::Ice::noExplicitContext)
 Returns a sequence of strings describing the constraints in this set. More...
 
::std::function< void()> getAsync (::std::function< void(::Ice::StringSeq)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Returns a sequence of strings describing the constraints in this set. More...
 
template<template< typename > class P = ::std::promise>
auto getAsync (const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::Ice::StringSeq >>().get_future())
 Returns a sequence of strings describing the constraints in this set. More...
 
void remove (const ::Ice::StringSeq &deletions, const ::Ice::Context &context=::Ice::noExplicitContext)
 Remove a sequence of strings from this set of constraints. More...
 
::std::function< void()> removeAsync (const ::Ice::StringSeq &deletions, ::std::function< void()> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
 Remove a sequence of strings from this set of constraints. More...
 
template<template< typename > class P = ::std::promise>
auto removeAsync (const ::Ice::StringSeq &deletions, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< void >>().get_future())
 Remove a sequence of strings from this set of constraints. More...
 
- Public Member Functions inherited from Ice::Proxy< StringSetPrx, ::Ice::ObjectPrx >
::std::shared_ptr< StringSetPrx > ice_adapterId (const ::std::string &id) const
 Obtains a proxy that is identical to this proxy, except for the adapter ID. More...
 
::std::shared_ptr< StringSetPrx > ice_batchDatagram () const
 Obtains a proxy that is identical to this proxy, but uses batch datagram invocations. More...
 
::std::shared_ptr< StringSetPrx > ice_batchOneway () const
 Obtains a proxy that is identical to this proxy, but uses batch oneway invocations. More...
 
::std::shared_ptr< StringSetPrx > ice_collocationOptimized (bool b) const
 Obtains a proxy that is identical to this proxy, except for collocation optimization. More...
 
::std::shared_ptr< StringSetPrx > ice_compress (bool b) const
 Obtains a proxy that is identical to this proxy, except for its compression setting which overrides the compression setting from the proxy endpoints. More...
 
::std::shared_ptr< StringSetPrx > ice_connectionCached (bool b) const
 Obtains a proxy that is identical to this proxy, except for connection caching. More...
 
::std::shared_ptr< StringSetPrx > ice_connectionId (const ::std::string &id) const
 Obtains a proxy that is identical to this proxy, except for its connection ID. More...
 
::std::shared_ptr< StringSetPrx > ice_context (const ::Ice::Context &context) const
 Obtains a proxy that is identical to this proxy, except for the per-proxy context. More...
 
::std::shared_ptr< StringSetPrx > ice_datagram () const
 Obtains a proxy that is identical to this proxy, but uses datagram invocations. More...
 
::std::shared_ptr< StringSetPrx > ice_encodingVersion (const ::Ice::EncodingVersion &version) const
 Obtains a proxy that is identical to this proxy, except for the encoding used to marshal parameters. More...
 
::std::shared_ptr< StringSetPrx > ice_endpoints (const ::Ice::EndpointSeq &endpoints) const
 Obtains a proxy that is identical to this proxy, except for the endpoints. More...
 
::std::shared_ptr< StringSetPrx > ice_endpointSelection (::Ice::EndpointSelectionType type) const
 Obtains a proxy that is identical to this proxy, except for the endpoint selection policy. More...
 
::std::shared_ptr< StringSetPrx > ice_fixed (const ::std::shared_ptr<::Ice::Connection > &connection) const
 Obtains a proxy that is identical to this proxy, except it's a fixed proxy bound the given connection. More...
 
::std::shared_ptr< StringSetPrx > ice_invocationTimeout (int timeout) const
 Obtains a proxy that is identical to this proxy, except for the invocation timeout. More...
 
::std::shared_ptr< StringSetPrx > ice_locator (const ::std::shared_ptr<::Ice::LocatorPrx > &locator) const
 Obtains a proxy that is identical to this proxy, except for the locator. More...
 
::std::shared_ptr< StringSetPrx > ice_locatorCacheTimeout (int timeout) const
 Obtains a proxy that is identical to this proxy, except for the locator cache timeout. More...
 
::std::shared_ptr< StringSetPrx > ice_oneway () const
 Obtains a proxy that is identical to this proxy, but uses oneway invocations. More...
 
::std::shared_ptr< StringSetPrx > ice_preferSecure (bool b) const
 Obtains a proxy that is identical to this proxy, except for its endpoint selection policy. More...
 
::std::shared_ptr< StringSetPrx > ice_router (const ::std::shared_ptr<::Ice::RouterPrx > &router) const
 Obtains a proxy that is identical to this proxy, except for the router. More...
 
::std::shared_ptr< StringSetPrx > ice_secure (bool b) const
 Obtains a proxy that is identical to this proxy, except for how it selects endpoints. More...
 
::std::shared_ptr< StringSetPrx > ice_timeout (int timeout) const
 Obtains a proxy that is identical to this proxy, except for its connection timeout setting which overrides the timeot setting from the proxy endpoints. More...
 
::std::shared_ptr< StringSetPrx > ice_twoway () const
 Obtains a proxy that is identical to this proxy, but uses twoway invocations. More...
 

Static Public Member Functions

static const ::std::string & ice_staticId ()
 Obtains the Slice type ID of this interface. More...
 

Detailed Description

An object for managing the set of identity constraints for specific parts of object identity on a Session.

See also
Session
SessionControl

Member Function Documentation

◆ add()

void Glacier2::StringSetPrx::add ( const ::Ice::StringSeq additions,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Add a sequence of strings to this set of constraints.

Order is not preserved and duplicates are implicitly removed.

Parameters
additionsThe sequence of strings to be added.
contextThe Context map to send with the invocation.

◆ addAsync() [1/2]

::std::function<void()> Glacier2::StringSetPrx::addAsync ( const ::Ice::StringSeq additions,
::std::function< void()>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Add a sequence of strings to this set of constraints.

Order is not preserved and duplicates are implicitly removed.

Parameters
additionsThe sequence of strings to be added.
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ addAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto Glacier2::StringSetPrx::addAsync ( const ::Ice::StringSeq additions,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<void>>().get_future())
inline

Add a sequence of strings to this set of constraints.

Order is not preserved and duplicates are implicitly removed.

Parameters
additionsThe sequence of strings to be added.
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ get()

::Ice::StringSeq Glacier2::StringSetPrx::get ( const ::Ice::Context context = ::Ice::noExplicitContext)
inline

Returns a sequence of strings describing the constraints in this set.

Parameters
contextThe Context map to send with the invocation.
Returns
The sequence of strings for this set.

◆ getAsync() [1/2]

::std::function<void()> Glacier2::StringSetPrx::getAsync ( ::std::function< void(::Ice::StringSeq)>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Returns a sequence of strings describing the constraints in this set.

Parameters
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ getAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto Glacier2::StringSetPrx::getAsync ( const ::Ice::Context context = ::Ice::noExplicitContext) -> decltype(::std::declval<P<::Ice::StringSeq>>().get_future())
inline

Returns a sequence of strings describing the constraints in this set.

Parameters
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

◆ ice_staticId()

static const ::std::string& Glacier2::StringSetPrx::ice_staticId ( )
static

Obtains the Slice type ID of this interface.

Returns
The fully-scoped type ID.

◆ remove()

void Glacier2::StringSetPrx::remove ( const ::Ice::StringSeq deletions,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Remove a sequence of strings from this set of constraints.

No errors are returned if an entry is not found.

Parameters
deletionsThe sequence of strings to be removed.
contextThe Context map to send with the invocation.

◆ removeAsync() [1/2]

::std::function<void()> Glacier2::StringSetPrx::removeAsync ( const ::Ice::StringSeq deletions,
::std::function< void()>  response,
::std::function< void(::std::exception_ptr)>  ex = nullptr,
::std::function< void(bool)>  sent = nullptr,
const ::Ice::Context context = ::Ice::noExplicitContext 
)
inline

Remove a sequence of strings from this set of constraints.

No errors are returned if an entry is not found.

Parameters
deletionsThe sequence of strings to be removed.
responseThe response callback.
exThe exception callback.
sentThe sent callback.
contextThe Context map to send with the invocation.
Returns
A function that can be called to cancel the invocation locally.

◆ removeAsync() [2/2]

template<template< typename > class P = ::std::promise>
auto Glacier2::StringSetPrx::removeAsync ( const ::Ice::StringSeq deletions,
const ::Ice::Context context = ::Ice::noExplicitContext 
) -> decltype(::std::declval<P<void>>().get_future())
inline

Remove a sequence of strings from this set of constraints.

No errors are returned if an entry is not found.

Parameters
deletionsThe sequence of strings to be removed.
contextThe Context map to send with the invocation.
Returns
The future object for the invocation.

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