An administrative interface for process management. More...

#include <Ice/Ice.h>

Inheritance diagram for Ice::ProcessPrx:

[legend]

Collaboration diagram for Ice::ProcessPrx:

[legend]

Public Member Functions
void	shutdown (const Context &context=noExplicitContext)
	Initiate a graceful shut-down.
::std::function< void()>	shutdownAsync (::std::function< void()> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const Context &context=noExplicitContext)
	Initiate a graceful shut-down.
template<template< typename > class P = ::std::promise>
auto	shutdownAsync (const Context &context=noExplicitContext) -> decltype(::std::declval< P< void > >().get_future())
	Initiate a graceful shut-down.
void	writeMessage (const ::std::string &message, int fd, const Context &context=noExplicitContext)
	Write a message on the process' stdout or stderr.
::std::function< void()>	writeMessageAsync (const ::std::string &message, int fd, ::std::function< void()> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const Context &context=noExplicitContext)
	Write a message on the process' stdout or stderr.
template<template< typename > class P = ::std::promise>
auto	writeMessageAsync (const ::std::string &message, int fd, const Context &context=noExplicitContext) -> decltype(::std::declval< P< void > >().get_future())
	Write a message on the process' stdout or stderr.
Public Member Functions inherited from Ice::Proxy< ProcessPrx, ObjectPrx >
::std::shared_ptr< ProcessPrx >	ice_adapterId (const ::std::string &id) const
	Obtains a proxy that is identical to this proxy, except for the adapter ID.
::std::shared_ptr< ProcessPrx >	ice_batchDatagram () const
	Obtains a proxy that is identical to this proxy, but uses batch datagram invocations.
::std::shared_ptr< ProcessPrx >	ice_batchOneway () const
	Obtains a proxy that is identical to this proxy, but uses batch oneway invocations.
::std::shared_ptr< ProcessPrx >	ice_collocationOptimized (bool b) const
	Obtains a proxy that is identical to this proxy, except for collocation optimization.
::std::shared_ptr< ProcessPrx >	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.
::std::shared_ptr< ProcessPrx >	ice_connectionCached (bool b) const
	Obtains a proxy that is identical to this proxy, except for connection caching.
::std::shared_ptr< ProcessPrx >	ice_connectionId (const ::std::string &id) const
	Obtains a proxy that is identical to this proxy, except for its connection ID.
::std::shared_ptr< ProcessPrx >	ice_context (const ::Ice::Context &context) const
	Obtains a proxy that is identical to this proxy, except for the per-proxy context.
::std::shared_ptr< ProcessPrx >	ice_datagram () const
	Obtains a proxy that is identical to this proxy, but uses datagram invocations.
::std::shared_ptr< ProcessPrx >	ice_encodingVersion (const ::Ice::EncodingVersion &version) const
	Obtains a proxy that is identical to this proxy, except for the encoding used to marshal parameters.
::std::shared_ptr< ProcessPrx >	ice_endpoints (const ::Ice::EndpointSeq &endpoints) const
	Obtains a proxy that is identical to this proxy, except for the endpoints.
::std::shared_ptr< ProcessPrx >	ice_endpointSelection (::Ice::EndpointSelectionType type) const
	Obtains a proxy that is identical to this proxy, except for the endpoint selection policy.
::std::shared_ptr< ProcessPrx >	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.
::std::shared_ptr< ProcessPrx >	ice_invocationTimeout (int timeout) const
	Obtains a proxy that is identical to this proxy, except for the invocation timeout.
::std::shared_ptr< ProcessPrx >	ice_locator (const ::std::shared_ptr<::Ice::LocatorPrx > &locator) const
	Obtains a proxy that is identical to this proxy, except for the locator.
::std::shared_ptr< ProcessPrx >	ice_locatorCacheTimeout (int timeout) const
	Obtains a proxy that is identical to this proxy, except for the locator cache timeout.
::std::shared_ptr< ProcessPrx >	ice_oneway () const
	Obtains a proxy that is identical to this proxy, but uses oneway invocations.
::std::shared_ptr< ProcessPrx >	ice_preferSecure (bool b) const
	Obtains a proxy that is identical to this proxy, except for its endpoint selection policy.
::std::shared_ptr< ProcessPrx >	ice_router (const ::std::shared_ptr<::Ice::RouterPrx > &router) const
	Obtains a proxy that is identical to this proxy, except for the router.
::std::shared_ptr< ProcessPrx >	ice_secure (bool b) const
	Obtains a proxy that is identical to this proxy, except for how it selects endpoints.
::std::shared_ptr< ProcessPrx >	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.
::std::shared_ptr< ProcessPrx >	ice_twoway () const
	Obtains a proxy that is identical to this proxy, but uses twoway invocations.

Static Public Member Functions
static const ::std::string &	ice_staticId ()
	Obtains the Slice type ID of this interface.

Detailed Description

An administrative interface for process management.

Managed servers must implement this interface.

A servant implementing this interface is a potential target for denial-of-service attacks, therefore proper security precautions should be taken. For example, the servant can use a UUID to make its identity harder to guess, and be registered in an object adapter with a secured endpoint.

Member Function Documentation

◆ ice_staticId()

const ::std::string & Ice::ProcessPrx::ice_staticId ( )

static

Obtains the Slice type ID of this interface.

Returns: The fully-scoped type ID.

◆ shutdown()

void Ice::ProcessPrx::shutdown ( const Context & context = noExplicitContext )

inline

Initiate a graceful shut-down.

Parameters

context The Context map to send with the invocation.

See also: Communicator::shutdown

◆ shutdownAsync() [1/2]

::std::function< void()> Ice::ProcessPrx::shutdownAsync	(	::std::function< void()>	response,
		::std::function< void(::std::exception_ptr)>	ex = nullptr,
		::std::function< void(bool)>	sent = nullptr,
		const Context &	context = noExplicitContext )

inline

Initiate a graceful shut-down.

Parameters

response	The response callback.
ex	The exception callback.
sent	The sent callback.
context	The Context map to send with the invocation.

Returns: A function that can be called to cancel the invocation locally.

See also: Communicator::shutdown

◆ shutdownAsync() [2/2]

template<template< typename > class P = ::std::promise>

auto Ice::ProcessPrx::shutdownAsync ( const Context & context = noExplicitContext ) -> decltype(::std::declval< P< void > >().get_future())

inline

Initiate a graceful shut-down.

Parameters

context The Context map to send with the invocation.

Returns: The future object for the invocation.

See also: Communicator::shutdown

◆ writeMessage()

void Ice::ProcessPrx::writeMessage	(	const ::std::string &	message,
		int	fd,
		const Context &	context = noExplicitContext )

inline

Write a message on the process' stdout or stderr.

Parameters

message	The message.
fd	1 for stdout, 2 for stderr.
context	The Context map to send with the invocation.

◆ writeMessageAsync() [1/2]

::std::function< void()> Ice::ProcessPrx::writeMessageAsync	(	const ::std::string &	message,
		int	fd,
		::std::function< void()>	response,
		::std::function< void(::std::exception_ptr)>	ex = nullptr,
		::std::function< void(bool)>	sent = nullptr,
		const Context &	context = noExplicitContext )

inline

Write a message on the process' stdout or stderr.

Parameters

message	The message.
fd	1 for stdout, 2 for stderr.
response	The response callback.
ex	The exception callback.
sent	The sent callback.
context	The Context map to send with the invocation.

Returns: A function that can be called to cancel the invocation locally.

◆ writeMessageAsync() [2/2]

template<template< typename > class P = ::std::promise>

auto Ice::ProcessPrx::writeMessageAsync	(	const ::std::string &	message,
		int	fd,
		const Context &	context = noExplicitContext ) -> decltype(::std::declval< P< void > >().get_future())

inline

Write a message on the process' stdout or stderr.

Parameters

message	The message.
fd	1 for stdout, 2 for stderr.
context	The 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:

generated/cpp11/x64/Release/Ice/Process.h

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ ice_staticId()

◆ shutdown()

◆ shutdownAsync() [1/2]

◆ shutdownAsync() [2/2]

◆ writeMessage()

◆ writeMessageAsync() [1/2]

◆ writeMessageAsync() [2/2]