Ice 3.7 C++11 API Reference
Public Types | Public Member Functions | Static Public Member Functions | List of all members
Ice::Process Class Referenceabstract

An administrative interface for process management. More...

#include <Ice/Ice.h>

Inheritance diagram for Ice::Process:
Inheritance graph
[legend]
Collaboration diagram for Ice::Process:
Collaboration graph
[legend]

Public Types

using ProxyType = ProcessPrx
 

Public Member Functions

virtual ::std::string ice_id (const Current &current) const override
 Obtains a Slice type ID representing the most-derived interface supported by this object. More...
 
virtual ::std::vector<::std::string > ice_ids (const Current &current) const override
 Obtains a list of the Slice type IDs representing the interfaces supported by this object. More...
 
virtual bool ice_isA (::std::string id, const Current &current) const override
 Determines whether this object supports an interface with the given Slice type ID. More...
 
virtual void shutdown (const Current &current)=0
 Initiate a graceful shut-down. More...
 
virtual void writeMessage (::std::string message, int fd, const Current &current)=0
 Write a message on the process' stdout or stderr. More...
 
- Public Member Functions inherited from Ice::Object
virtual bool ice_dispatch (Ice::Request &request, std::function< bool()> response=nullptr, std::function< bool(std::exception_ptr)> error=nullptr)
 Dispatches an invocation to a servant. More...
 
virtual bool ice_isA (std::string s, const Current &current) const
 Tests whether this object supports a specific Slice interface. More...
 
virtual void ice_ping (const Current &current) const
 Tests whether this object can be reached. More...
 
virtual ~Object ()=default
 

Static Public Member Functions

static const ::std::string & ice_staticId ()
 Obtains the Slice type ID corresponding to this class. More...
 
- Static Public Member Functions inherited from Ice::Object
static const std::string & ice_staticId ()
 Obtains the Slice type ID of this type. More...
 

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 Typedef Documentation

◆ ProxyType

Member Function Documentation

◆ ice_id()

virtual ::std::string Ice::Process::ice_id ( const Current current) const
overridevirtual

Obtains a Slice type ID representing the most-derived interface supported by this object.

Parameters
currentThe Current object for the invocation.
Returns
A fully-scoped type ID.

Reimplemented from Ice::Object.

◆ ice_ids()

virtual ::std::vector<::std::string> Ice::Process::ice_ids ( const Current current) const
overridevirtual

Obtains a list of the Slice type IDs representing the interfaces supported by this object.

Parameters
currentThe Current object for the invocation.
Returns
A list of fully-scoped type IDs.

Reimplemented from Ice::Object.

◆ ice_isA()

virtual bool Ice::Process::ice_isA ( ::std::string  id,
const Current current 
) const
overridevirtual

Determines whether this object supports an interface with the given Slice type ID.

Parameters
idThe fully-scoped Slice type ID.
currentThe Current object for the invocation.
Returns
True if this object supports the interface, false, otherwise.

◆ ice_staticId()

static const ::std::string& Ice::Process::ice_staticId ( )
static

Obtains the Slice type ID corresponding to this class.

Returns
A fully-scoped type ID.

◆ shutdown()

virtual void Ice::Process::shutdown ( const Current current)
pure virtual

Initiate a graceful shut-down.

Parameters
currentThe Current object for the invocation.
See also
Communicator::shutdown

◆ writeMessage()

virtual void Ice::Process::writeMessage ( ::std::string  message,
int  fd,
const Current current 
)
pure virtual

Write a message on the process' stdout or stderr.

Parameters
messageThe message.
fd1 for stdout, 2 for stderr.
currentThe Current object for the invocation.

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