Helper template that supplies proxy factory functions. More...

#include <Ice/Ice.h>

Inheritance diagram for Ice::Proxy< Prx, Bases >:

Collaboration diagram for Ice::Proxy< Prx, Bases >:

Public Member Functions
::std::shared_ptr< Prx >	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< Prx >	ice_batchDatagram () const
	Obtains a proxy that is identical to this proxy, but uses batch datagram invocations. More...

::std::shared_ptr< Prx >	ice_batchOneway () const
	Obtains a proxy that is identical to this proxy, but uses batch oneway invocations. More...

::std::shared_ptr< Prx >	ice_collocationOptimized (bool b) const
	Obtains a proxy that is identical to this proxy, except for collocation optimization. More...

::std::shared_ptr< Prx >	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< Prx >	ice_connectionCached (bool b) const
	Obtains a proxy that is identical to this proxy, except for connection caching. More...

::std::shared_ptr< Prx >	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< Prx >	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< Prx >	ice_datagram () const
	Obtains a proxy that is identical to this proxy, but uses datagram invocations. More...

::std::shared_ptr< Prx >	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< Prx >	ice_endpoints (const ::Ice::EndpointSeq &endpoints) const
	Obtains a proxy that is identical to this proxy, except for the endpoints. More...

::std::shared_ptr< Prx >	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< Prx >	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< Prx >	ice_invocationTimeout (int timeout) const
	Obtains a proxy that is identical to this proxy, except for the invocation timeout. More...

::std::shared_ptr< Prx >	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< Prx >	ice_locatorCacheTimeout (int timeout) const
	Obtains a proxy that is identical to this proxy, except for the locator cache timeout. More...

::std::shared_ptr< Prx >	ice_oneway () const
	Obtains a proxy that is identical to this proxy, but uses oneway invocations. More...

::std::shared_ptr< Prx >	ice_preferSecure (bool b) const
	Obtains a proxy that is identical to this proxy, except for its endpoint selection policy. More...

::std::shared_ptr< Prx >	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< Prx >	ice_secure (bool b) const
	Obtains a proxy that is identical to this proxy, except for how it selects endpoints. More...

::std::shared_ptr< Prx >	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< Prx >	ice_twoway () const
	Obtains a proxy that is identical to this proxy, but uses twoway invocations. More...

Detailed Description

template<typename Prx, typename... Bases>
class Ice::Proxy< Prx, Bases >

Helper template that supplies proxy factory functions.

Member Function Documentation

◆ ice_adapterId()

template<typename Prx , typename... Bases>

::std::shared_ptr<Prx> Ice::Proxy< Prx, Bases >::ice_adapterId ( const ::std::string & id ) const

inline

Obtains a proxy that is identical to this proxy, except for the adapter ID.

Parameters

id	The adapter ID for the new proxy.

Returns: A proxy with the new adapter ID.

◆ ice_batchDatagram()

template<typename Prx , typename... Bases>

::std::shared_ptr<Prx> Ice::Proxy< Prx, Bases >::ice_batchDatagram ( ) const

inline

Obtains a proxy that is identical to this proxy, but uses batch datagram invocations.

Returns: A proxy that uses batch datagram invocations.

◆ ice_batchOneway()

template<typename Prx , typename... Bases>

::std::shared_ptr<Prx> Ice::Proxy< Prx, Bases >::ice_batchOneway ( ) const

inline

Obtains a proxy that is identical to this proxy, but uses batch oneway invocations.

Returns: A proxy that uses batch oneway invocations.

◆ ice_collocationOptimized()

template<typename Prx , typename... Bases>

::std::shared_ptr<Prx> Ice::Proxy< Prx, Bases >::ice_collocationOptimized ( bool b ) const

inline

Obtains a proxy that is identical to this proxy, except for collocation optimization.

Parameters

b	True if the new proxy enables collocation optimization, false otherwise.

Returns: A proxy with the specified collocation optimization.

◆ ice_compress()

template<typename Prx , typename... Bases>

::std::shared_ptr<Prx> Ice::Proxy< Prx, Bases >::ice_compress ( bool b ) const

inline

Obtains a proxy that is identical to this proxy, except for its compression setting which overrides the compression setting from the proxy endpoints.

Parameters

b	True enables compression for the new proxy, false disables compression.

Returns: A proxy with the specified compression override setting.

◆ ice_connectionCached()

template<typename Prx , typename... Bases>

::std::shared_ptr<Prx> Ice::Proxy< Prx, Bases >::ice_connectionCached ( bool b ) const

inline

Obtains a proxy that is identical to this proxy, except for connection caching.

Parameters

b	True if the new proxy should cache connections, false otherwise.

Returns: A proxy with the specified caching policy.

◆ ice_connectionId()

template<typename Prx , typename... Bases>

::std::shared_ptr<Prx> Ice::Proxy< Prx, Bases >::ice_connectionId ( const ::std::string & id ) const

inline

Obtains a proxy that is identical to this proxy, except for its connection ID.

Parameters

id	The connection ID for the new proxy. An empty string removes the connection ID.

Returns: A proxy with the specified connection ID.

◆ ice_context()

template<typename Prx , typename... Bases>

::std::shared_ptr<Prx> Ice::Proxy< Prx, Bases >::ice_context ( const ::Ice::Context & context ) const

inline

Obtains a proxy that is identical to this proxy, except for the per-proxy context.

Parameters

context The context for the new proxy.

Returns: A proxy with the new per-proxy context.

◆ ice_datagram()

template<typename Prx , typename... Bases>

::std::shared_ptr<Prx> Ice::Proxy< Prx, Bases >::ice_datagram ( ) const

inline

Obtains a proxy that is identical to this proxy, but uses datagram invocations.

Returns: A proxy that uses datagram invocations.

◆ ice_encodingVersion()

template<typename Prx , typename... Bases>

::std::shared_ptr<Prx> Ice::Proxy< Prx, Bases >::ice_encodingVersion ( const ::Ice::EncodingVersion & version ) const

inline

Obtains a proxy that is identical to this proxy, except for the encoding used to marshal parameters.

Parameters

version The encoding version to use to marshal request parameters.

Returns: A proxy with the specified encoding version.

◆ ice_endpoints()

template<typename Prx , typename... Bases>

::std::shared_ptr<Prx> Ice::Proxy< Prx, Bases >::ice_endpoints ( const ::Ice::EndpointSeq & endpoints ) const

inline

Obtains a proxy that is identical to this proxy, except for the endpoints.

Parameters

endpoints The endpoints for the new proxy.

Returns: A proxy with the new endpoints.

◆ ice_endpointSelection()

template<typename Prx , typename... Bases>

::std::shared_ptr<Prx> Ice::Proxy< Prx, Bases >::ice_endpointSelection ( ::Ice::EndpointSelectionType type ) const

inline

Obtains a proxy that is identical to this proxy, except for the endpoint selection policy.

Parameters

type	The new endpoint selection policy.

Returns: A proxy with the specified endpoint selection policy.

◆ ice_fixed()

template<typename Prx , typename... Bases>

::std::shared_ptr<Prx> Ice::Proxy< Prx, Bases >::ice_fixed ( const ::std::shared_ptr<::Ice::Connection > & connection ) const

inline

Obtains a proxy that is identical to this proxy, except it's a fixed proxy bound the given connection.

Parameters

connection The fixed proxy connection.

Returns: A fixed proxy bound to the given connection.

◆ ice_invocationTimeout()

template<typename Prx , typename... Bases>

::std::shared_ptr<Prx> Ice::Proxy< Prx, Bases >::ice_invocationTimeout ( int timeout ) const

inline

Obtains a proxy that is identical to this proxy, except for the invocation timeout.

Parameters

timeout The new invocation timeout (in milliseconds).

Returns: A proxy with the new timeout.

◆ ice_locator()

template<typename Prx , typename... Bases>

::std::shared_ptr<Prx> Ice::Proxy< Prx, Bases >::ice_locator ( const ::std::shared_ptr<::Ice::LocatorPrx > & locator ) const

inline

Obtains a proxy that is identical to this proxy, except for the locator.

Parameters

locator The locator for the new proxy.

Returns: A proxy with the specified locator.

◆ ice_locatorCacheTimeout()

template<typename Prx , typename... Bases>

::std::shared_ptr<Prx> Ice::Proxy< Prx, Bases >::ice_locatorCacheTimeout ( int timeout ) const

inline

Obtains a proxy that is identical to this proxy, except for the locator cache timeout.

Parameters

timeout The new locator cache timeout (in seconds).

Returns: A proxy with the new timeout.

◆ ice_oneway()

template<typename Prx , typename... Bases>

::std::shared_ptr<Prx> Ice::Proxy< Prx, Bases >::ice_oneway ( ) const

inline

Obtains a proxy that is identical to this proxy, but uses oneway invocations.

Returns: A proxy that uses oneway invocations.

◆ ice_preferSecure()

template<typename Prx , typename... Bases>

::std::shared_ptr<Prx> Ice::Proxy< Prx, Bases >::ice_preferSecure ( bool b ) const

inline

Obtains a proxy that is identical to this proxy, except for its endpoint selection policy.

Parameters

b	If true, the new proxy will use secure endpoints for invocations and only use insecure endpoints if an invocation cannot be made via secure endpoints. If false, the proxy prefers insecure endpoints to secure ones.

Returns: A proxy with the specified selection policy.

◆ ice_router()

template<typename Prx , typename... Bases>

::std::shared_ptr<Prx> Ice::Proxy< Prx, Bases >::ice_router ( const ::std::shared_ptr<::Ice::RouterPrx > & router ) const

inline

Obtains a proxy that is identical to this proxy, except for the router.

Parameters

router The router for the new proxy.

Returns: A proxy with the specified router.

◆ ice_secure()

template<typename Prx , typename... Bases>

::std::shared_ptr<Prx> Ice::Proxy< Prx, Bases >::ice_secure ( bool b ) const

inline

Obtains a proxy that is identical to this proxy, except for how it selects endpoints.

Parameters

b	If true, only endpoints that use a secure transport are used by the new proxy. If false, the returned proxy uses both secure and insecure endpoints.

Returns: A proxy with the specified security policy.

◆ ice_timeout()

template<typename Prx , typename... Bases>

::std::shared_ptr<Prx> Ice::Proxy< Prx, Bases >::ice_timeout ( int timeout ) const

inline

Obtains a proxy that is identical to this proxy, except for its connection timeout setting which overrides the timeot setting from the proxy endpoints.

Parameters

timeout The connection timeout override for the proxy (in milliseconds).

Returns: A proxy with the specified timeout override.

◆ ice_twoway()

template<typename Prx , typename... Bases>

::std::shared_ptr<Prx> Ice::Proxy< Prx, Bases >::ice_twoway ( ) const

inline

Obtains a proxy that is identical to this proxy, but uses twoway invocations.

Returns: A proxy that uses twoway invocations.

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

Ice/Proxy.h

Public Member Functions

Detailed Description

template<typename Prx, typename... Bases> class Ice::Proxy< Prx, Bases >

Member Function Documentation

◆ ice_adapterId()

◆ ice_batchDatagram()

◆ ice_batchOneway()

◆ ice_collocationOptimized()

◆ ice_compress()

◆ ice_connectionCached()

◆ ice_connectionId()

◆ ice_context()

◆ ice_datagram()

◆ ice_encodingVersion()

◆ ice_endpoints()

◆ ice_endpointSelection()

◆ ice_fixed()

◆ ice_invocationTimeout()

◆ ice_locator()

◆ ice_locatorCacheTimeout()

◆ ice_oneway()

◆ ice_preferSecure()

◆ ice_router()

◆ ice_secure()

◆ ice_timeout()

◆ ice_twoway()

template<typename Prx, typename... Bases>
class Ice::Proxy< Prx, Bases >