Ice Reference Documentation | ||
---|---|---|
<<< Previous | Slice Documentation | Next >>> |
interface |
The IcePack administrative interface.
![]() | Allowing access to this interface is a security risk! Please see the IcePack documentation for further information. |
Add an application to IcePack.
Add an object to the object registry.
Add an object to the object registry and explicitly specify its type.
Add a server to an IcePack node.
Get the list of endpoints for an adapter.
Get all the adapter ids registered with IcePack.
Get all the IcePack applications currently registered.
Get all the IcePack nodes currently registered.
Get the descriptors of all registered objects whose stringified identities match the given expression.
Get all the server names registered with IcePack.
Get an application descriptor.
Get the hostname of this node.
Get the object descriptor if the object with the given identity.
Get the server's activation mode.
Get a server descriptor.
Get a server's system process id.
Get a server's state.
Returns the checksums for the IcePack Slice definitions.
Ping an IcePack node to see if it is active.
Remove an application from IcePack.
Remove the given node and associated servers from the IcePack registry.
Remove an object from the object registry.
Remove a server from an IcePack node.
Send signal to a server.
Set the server's activation mode.
Shut down the IcePack registry.
Shutdown an IcePack node.
Start a server.
Stop a server.
Update an application.
Update a server.
Write message on server stdout or stderr @param name The name of the server.
void addApplication( |
Add an application to IcePack. An application is a set of servers.
The application descriptor.
DeploymentException
Raised if application deployment failed.
void addObject(Object* obj) throws |
Add an object to the object registry. IcePack will get the object type by calling ice_id on the given proxy. The object must be reachable.
The object to be added to the registry.
ObjectExistsException
Raised if the object is already registered.
void addObjectWithType(Object* obj,
string type)
throws
|
Add an object to the object registry and explicitly specify its type.
The object to be added to the registry.
The object type.
ObjectExistsException
Raised if the object is already registered.
void addServer( |
Add a server to an IcePack node.
The server deployment descriptor.
DeploymentException
Raised if server deployment failed.
string getAdapterEndpoints(string id) throws |
Get the list of endpoints for an adapter.
The adapter id.
The stringified adapter endpoints.
AdapterNotExistException
Raised if the adapter is not found.
::Ice::StringSeq getAllAdapterIds(); |
Get all the adapter ids registered with IcePack.
The adapter ids.
::Ice::StringSeq getAllApplicationNames(); |
Get all the IcePack applications currently registered.
The application names.
::Ice::StringSeq getAllNodeNames(); |
Get all the IcePack nodes currently registered.
The node names.
ObjectDescriptorSeq getAllObjectDescriptors(string expr); |
Get the descriptors of all registered objects whose stringified identities match the given expression.
The expression to match against the stringified identities of registered objects. The expression may contain a trailing wildcard (*) character.
All the object descriptors with a stringified identity matching the given expression.
::Ice::StringSeq getAllServerNames(); |
Get all the server names registered with IcePack.
The server names.
|
Get an application descriptor.
The application name.
s The application descriptor.
ApplicationNotExistException
Raised if the application doesn't exist.
string getNodeHostname(string name) throws |
Get the hostname of this node.
The node name.
|
Get the object descriptor if the object with the given identity.
The identity of the object.
The object descriptor.
Raised if the object cannot be found.
ServerActivation getServerActivation(string name) throws |
Get the server's activation mode.
The name of the server.
The server activation mode.
ServerNotExistException
Raised if the server is not found.
NodeUnreachableException
Raised if the node could not be reached.
|
Get a server descriptor.
The server name.
s The server descriptor.
ServerNotExistException
Raised if the server doesn't exist.
int getServerPid(string name) throws |
Get a server's system process id. The process id is operating system dependent.
The name of the server.
The server process id.
ServerNotExistException
Raised if the server is not found.
NodeUnreachableException
Raised if the node could not be reached.
ServerState getServerState(string name) throws |
Get a server's state.
The name of the server.
The server state.
ServerNotExistException
Raised if the server is not found.
NodeUnreachableException
Raised if the node could not be reached.
::Ice::SliceChecksumDict getSliceChecksums(); |
Returns the checksums for the IcePack Slice definitions.
A dictionary mapping Slice type ids to their checksums.
bool pingNode(string name)
throws
|
Ping an IcePack node to see if it is active.
The node name.
true if the node ping succeeded, false otherwise.
void removeApplication(string name)
throws
|
Remove an application from IcePack.
The application name.
void removeNode(string name)
throws
|
Remove the given node and associated servers from the IcePack registry.
The node name.
void removeObject( |
Remove an object from the object registry.
The identity of the object to be removed from the registry.
ObjectNotExistException
Raised if the object cannot be found.
void removeServer(string name) throws |
Remove a server from an IcePack node.
The server name.
ServerNotExistException
Raised if the server doesn't exist.
void sendSignal(string name, string signal) throws |
Send signal to a server.
The name of the server.
The signal, for example SIGTERM or 15.
ServerNotExistException
Raised if the server is not found.
NodeUnreachableException
Raised if the node could not be reached.
BadSignalException
Raised if the signal is not recognized by the target server.
void setServerActivation(string name, ServerActivation mode) throws |
Set the server's activation mode.
The name of the server.
The server activation mode.
ServerNotExistException
Raised if the server is not found.
NodeUnreachableException
Raised if the node could not be reached.
void shutdownNode(string name) throws |
Shutdown an IcePack node.
The node name.
bool startServer(string name) throws |
Start a server.
The name of the server.
True if the server was successfully started, false otherwise.
ServerNotExistException
Raised if the server is not found.
NodeUnreachableException
Raised if the node could not be reached.
void stopServer(string name) throws |
Stop a server.
The name of the server.
ServerNotExistException
Raised if the server is not found.
NodeUnreachableException
Raised if the node could not be reached.
void updateApplication( |
Update an application. An application is a set of servers.
The application descriptor.
DeploymentException
Raised if application deployment failed.
void updateServer( |
Update a server.
The server deployment descriptor.
DeploymentException
Raised if server deployment failed.
ServerNotExistException
Raised if the server doesn't exist.
void writeMessage(string name, string message, int fd) throws |
Write message on server stdout or stderr
The name of the server.
The message.
1 for stdout, 2 for stderr.
ServerNotExistException
Raised if the server is not found.
NodeUnreachableException
Raised if the node could not be reached.
<<< Previous | Home | Next >>> |
IcePack::AdapterNotExistException | Up | IcePack::ApplicationDescriptor |