Ice 3.8
C++ API Reference
Loading...
Searching...
No Matches
IceGrid::AdminSessionPrx Class Reference

Represents an administrative session between an admin tool and an IceGrid registry. More...

#include <IceGrid/IceGrid.h>

Inheritance diagram for IceGrid::AdminSessionPrx:

Public Member Functions

 AdminSessionPrx (AdminSessionPrx &&other) noexcept
 Move constructor.
 AdminSessionPrx (const AdminSessionPrx &other) noexcept
 Copy constructor.
 AdminSessionPrx (const Ice::CommunicatorPtr &communicator, std::string_view proxyString)
 Constructs a proxy from a Communicator and a proxy string.
void finishUpdate (const Ice::Context &context=Ice::noExplicitContext) const
 Finishes updating the registry and releases the exclusive lock.
std::future< void > finishUpdateAsync (const Ice::Context &context=Ice::noExplicitContext) const
 Finishes updating the registry and releases the exclusive lock.
std::function< void()> finishUpdateAsync (std::function< void()> response, std::function< void(std::exception_ptr)> exception=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const
 Finishes updating the registry and releases the exclusive lock.
std::optional< AdminPrxgetAdmin (const Ice::Context &context=Ice::noExplicitContext) const
 Gets a proxy to the IceGrid admin object.
std::future< std::optional< AdminPrx > > getAdminAsync (const Ice::Context &context=Ice::noExplicitContext) const
 Gets a proxy to the IceGrid admin object.
std::function< void()> getAdminAsync (std::function< void(std::optional<::IceGrid::AdminPrx >)> response, std::function< void(std::exception_ptr)> exception=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const
 Gets a proxy to the IceGrid admin object.
std::optional< Ice::ObjectPrxgetAdminCallbackTemplate (const Ice::Context &context=Ice::noExplicitContext) const
 Gets a "template" proxy for admin callback objects.
std::future< std::optional< Ice::ObjectPrx > > getAdminCallbackTemplateAsync (const Ice::Context &context=Ice::noExplicitContext) const
 Gets a "template" proxy for admin callback objects.
std::function< void()> getAdminCallbackTemplateAsync (std::function< void(std::optional< Ice::ObjectPrx >)> response, std::function< void(std::exception_ptr)> exception=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const
 Gets a "template" proxy for admin callback objects.
std::string getReplicaName (const Ice::Context &context=Ice::noExplicitContext) const
 Gets the name of the registry replica hosting this session.
std::future< std::string > getReplicaNameAsync (const Ice::Context &context=Ice::noExplicitContext) const
 Gets the name of the registry replica hosting this session.
std::function< void()> getReplicaNameAsync (std::function< void(std::string)> response, std::function< void(std::exception_ptr)> exception=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const
 Gets the name of the registry replica hosting this session.
void keepAlive (const Ice::Context &context=Ice::noExplicitContext) const
 Keeps the session alive.
std::future< void > keepAliveAsync (const Ice::Context &context=Ice::noExplicitContext) const
 Keeps the session alive.
std::function< void()> keepAliveAsync (std::function< void()> response, std::function< void(std::exception_ptr)> exception=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const
 Keeps the session alive.
std::optional< FileIteratorPrxopenNodeStdErr (std::string_view name, std::int32_t count, const Ice::Context &context=Ice::noExplicitContext) const
 Opens a node stderr file for reading.
std::future< std::optional< FileIteratorPrx > > openNodeStdErrAsync (std::string_view name, std::int32_t count, const Ice::Context &context=Ice::noExplicitContext) const
 Opens a node stderr file for reading.
std::function< void()> openNodeStdErrAsync (std::string_view name, std::int32_t count, std::function< void(std::optional<::IceGrid::FileIteratorPrx >)> response, std::function< void(std::exception_ptr)> exception=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const
 Opens a node stderr file for reading.
std::optional< FileIteratorPrxopenNodeStdOut (std::string_view name, std::int32_t count, const Ice::Context &context=Ice::noExplicitContext) const
 Opens a node stdout file for reading.
std::future< std::optional< FileIteratorPrx > > openNodeStdOutAsync (std::string_view name, std::int32_t count, const Ice::Context &context=Ice::noExplicitContext) const
 Opens a node stdout file for reading.
std::function< void()> openNodeStdOutAsync (std::string_view name, std::int32_t count, std::function< void(std::optional<::IceGrid::FileIteratorPrx >)> response, std::function< void(std::exception_ptr)> exception=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const
 Opens a node stdout file for reading.
std::optional< FileIteratorPrxopenRegistryStdErr (std::string_view name, std::int32_t count, const Ice::Context &context=Ice::noExplicitContext) const
 Opens a registry stderr file for reading.
std::future< std::optional< FileIteratorPrx > > openRegistryStdErrAsync (std::string_view name, std::int32_t count, const Ice::Context &context=Ice::noExplicitContext) const
 Opens a registry stderr file for reading.
std::function< void()> openRegistryStdErrAsync (std::string_view name, std::int32_t count, std::function< void(std::optional<::IceGrid::FileIteratorPrx >)> response, std::function< void(std::exception_ptr)> exception=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const
 Opens a registry stderr file for reading.
std::optional< FileIteratorPrxopenRegistryStdOut (std::string_view name, std::int32_t count, const Ice::Context &context=Ice::noExplicitContext) const
 Opens a registry stdout file for reading.
std::future< std::optional< FileIteratorPrx > > openRegistryStdOutAsync (std::string_view name, std::int32_t count, const Ice::Context &context=Ice::noExplicitContext) const
 Opens a registry stdout file for reading.
std::function< void()> openRegistryStdOutAsync (std::string_view name, std::int32_t count, std::function< void(std::optional<::IceGrid::FileIteratorPrx >)> response, std::function< void(std::exception_ptr)> exception=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const
 Opens a registry stdout file for reading.
std::optional< FileIteratorPrxopenServerLog (std::string_view id, std::string_view path, std::int32_t count, const Ice::Context &context=Ice::noExplicitContext) const
 Opens a server log file for reading.
std::future< std::optional< FileIteratorPrx > > openServerLogAsync (std::string_view id, std::string_view path, std::int32_t count, const Ice::Context &context=Ice::noExplicitContext) const
 Opens a server log file for reading.
std::function< void()> openServerLogAsync (std::string_view id, std::string_view path, std::int32_t count, std::function< void(std::optional<::IceGrid::FileIteratorPrx >)> response, std::function< void(std::exception_ptr)> exception=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const
 Opens a server log file for reading.
std::optional< FileIteratorPrxopenServerStdErr (std::string_view id, std::int32_t count, const Ice::Context &context=Ice::noExplicitContext) const
 Opens a server stderr file for reading.
std::future< std::optional< FileIteratorPrx > > openServerStdErrAsync (std::string_view id, std::int32_t count, const Ice::Context &context=Ice::noExplicitContext) const
 Opens a server stderr file for reading.
std::function< void()> openServerStdErrAsync (std::string_view id, std::int32_t count, std::function< void(std::optional<::IceGrid::FileIteratorPrx >)> response, std::function< void(std::exception_ptr)> exception=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const
 Opens a server stderr file for reading.
std::optional< FileIteratorPrxopenServerStdOut (std::string_view id, std::int32_t count, const Ice::Context &context=Ice::noExplicitContext) const
 Opens a server stdout file for reading.
std::future< std::optional< FileIteratorPrx > > openServerStdOutAsync (std::string_view id, std::int32_t count, const Ice::Context &context=Ice::noExplicitContext) const
 Opens a server stdout file for reading.
std::function< void()> openServerStdOutAsync (std::string_view id, std::int32_t count, std::function< void(std::optional<::IceGrid::FileIteratorPrx >)> response, std::function< void(std::exception_ptr)> exception=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const
 Opens a server stdout file for reading.
AdminSessionPrxoperator= (AdminSessionPrx &&rhs) noexcept
 Move assignment operator.
AdminSessionPrxoperator= (const AdminSessionPrx &rhs) noexcept
 Copy assignment operator.
void setObservers (const std::optional< RegistryObserverPrx > &registryObs, const std::optional< NodeObserverPrx > &nodeObs, const std::optional< ApplicationObserverPrx > &appObs, const std::optional< AdapterObserverPrx > &adptObs, const std::optional< ObjectObserverPrx > &objObs, const Ice::Context &context=Ice::noExplicitContext) const
 Sets the observer proxies that receive notifications when the state of the registry or nodes changes.
std::future< void > setObserversAsync (const std::optional< RegistryObserverPrx > &registryObs, const std::optional< NodeObserverPrx > &nodeObs, const std::optional< ApplicationObserverPrx > &appObs, const std::optional< AdapterObserverPrx > &adptObs, const std::optional< ObjectObserverPrx > &objObs, const Ice::Context &context=Ice::noExplicitContext) const
 Sets the observer proxies that receive notifications when the state of the registry or nodes changes.
std::function< void()> setObserversAsync (const std::optional< RegistryObserverPrx > &registryObs, const std::optional< NodeObserverPrx > &nodeObs, const std::optional< ApplicationObserverPrx > &appObs, const std::optional< AdapterObserverPrx > &adptObs, const std::optional< ObjectObserverPrx > &objObs, std::function< void()> response, std::function< void(std::exception_ptr)> exception=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const
 Sets the observer proxies that receive notifications when the state of the registry or nodes changes.
void setObserversByIdentity (const ::Ice::Identity &registryObs, const ::Ice::Identity &nodeObs, const ::Ice::Identity &appObs, const ::Ice::Identity &adptObs, const ::Ice::Identity &objObs, const Ice::Context &context=Ice::noExplicitContext) const
 Sets the observer identities that receive notifications when the state of the registry or nodes changes.
std::future< void > setObserversByIdentityAsync (const ::Ice::Identity &registryObs, const ::Ice::Identity &nodeObs, const ::Ice::Identity &appObs, const ::Ice::Identity &adptObs, const ::Ice::Identity &objObs, const Ice::Context &context=Ice::noExplicitContext) const
 Sets the observer identities that receive notifications when the state of the registry or nodes changes.
std::function< void()> setObserversByIdentityAsync (const ::Ice::Identity &registryObs, const ::Ice::Identity &nodeObs, const ::Ice::Identity &appObs, const ::Ice::Identity &adptObs, const ::Ice::Identity &objObs, std::function< void()> response, std::function< void(std::exception_ptr)> exception=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const
 Sets the observer identities that receive notifications when the state of the registry or nodes changes.
std::int32_t startUpdate (const Ice::Context &context=Ice::noExplicitContext) const
 Acquires an exclusive lock to start updating the registry applications.
std::future< std::int32_t > startUpdateAsync (const Ice::Context &context=Ice::noExplicitContext) const
 Acquires an exclusive lock to start updating the registry applications.
std::function< void()> startUpdateAsync (std::function< void(std::int32_t)> response, std::function< void(std::exception_ptr)> exception=nullptr, std::function< void(bool)> sent=nullptr, const Ice::Context &context=Ice::noExplicitContext) const
 Acquires an exclusive lock to start updating the registry applications.
Public Member Functions inherited from Ice::Proxy< AdminSessionPrx, ::Glacier2::SessionPrx >
AdminSessionPrx ice_adapterId (std::string id) const
 Creates a proxy that is identical to this proxy, except for the adapter ID.
AdminSessionPrx ice_batchDatagram () const
 Creates a proxy that is identical to this proxy, but uses batch datagram invocations.
AdminSessionPrx ice_batchOneway () const
 Creates a proxy that is identical to this proxy, but uses batch oneway invocations.
AdminSessionPrx ice_collocationOptimized (bool b) const
 Creates a proxy that is identical to this proxy, except for collocation optimization.
AdminSessionPrx ice_compress (bool b) const
 Creates a proxy that is identical to this proxy, except for its compression setting which overrides the compression setting from the proxy endpoints.
AdminSessionPrx ice_connectionCached (bool b) const
 Creates a proxy that is identical to this proxy, except for connection caching.
AdminSessionPrx ice_connectionId (std::string id) const
 Creates a proxy that is identical to this proxy, except for its connection ID.
AdminSessionPrx ice_context (Context context) const
 Creates a proxy that is identical to this proxy, except for the per-proxy context.
AdminSessionPrx ice_datagram () const
 Creates a proxy that is identical to this proxy, but uses datagram invocations.
AdminSessionPrx ice_encodingVersion (EncodingVersion version) const
 Creates a proxy that is identical to this proxy, except for the encoding used to marshal parameters.
AdminSessionPrx ice_endpoints (EndpointSeq endpoints) const
 Creates a proxy that is identical to this proxy, except for the endpoints.
AdminSessionPrx ice_endpointSelection (EndpointSelectionType type) const
 Creates a proxy that is identical to this proxy, except for the endpoint selection policy.
AdminSessionPrx ice_fixed (ConnectionPtr connection) const
 Creates a proxy that is identical to this proxy, except it's a fixed proxy bound to the given connection.
AdminSessionPrx ice_invocationTimeout (int timeout) const
 Creates a proxy that is identical to this proxy, except for the invocation timeout.
AdminSessionPrx ice_locator (const std::optional< LocatorPrx > &locator) const
 Creates a proxy that is identical to this proxy, except for the locator.
AdminSessionPrx ice_locatorCacheTimeout (int timeout) const
 Creates a proxy that is identical to this proxy, except for the locator cache timeout.
AdminSessionPrx ice_oneway () const
 Creates a proxy that is identical to this proxy, but uses oneway invocations.
AdminSessionPrx ice_router (const std::optional< RouterPrx > &router) const
 Creates a proxy that is identical to this proxy, except for the router.
AdminSessionPrx ice_twoway () const
 Creates a proxy that is identical to this proxy, but uses twoway invocations.
const AdminSessionPrx * operator-> () const noexcept
 The arrow operator.

Static Public Member Functions

static const char * ice_staticId () noexcept
 Gets the type ID of the associated Slice interface.

Detailed Description

Represents an administrative session between an admin tool and an IceGrid registry.

See also
Registry

Definition at line 2398 of file Admin.h.


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