Ice 3.7 Slice API Reference
IceBox.ice
Go to the documentation of this file.
1 //
2 // Copyright (c) ZeroC, Inc. All rights reserved.
3 //
4 
5 #pragma once
6 
7 [["cpp:dll-export:ICEBOX_API"]]
8 [["cpp:doxygen:include:IceBox/IceBox.h"]]
9 [["cpp:header-ext:h"]]
10 [["cpp:include:IceBox/Config.h"]]
11 
12 [["ice-prefix"]]
13 
14 [["js:module:ice"]]
15 [["js:cjs-module"]]
16 
17 [["objc:header-dir:objc"]]
18 
19 [["python:pkgdir:IceBox"]]
20 
21 #include <Ice/BuiltinSequences.ice>
22 #include <Ice/CommunicatorF.ice>
23 #include <Ice/PropertiesF.ice>
25 
26 #ifndef __SLICE2JAVA_COMPAT__
27 [["java:package:com.zeroc"]]
28 #endif
29 
38 module IceBox
39 {
40 
49 ["cpp:ice_print"]
50 local exception FailureException
51 {
57  string reason;
58 }
59 
67 {
68 }
69 
77 {
78 }
79 
87 {
88 }
89 
95 local interface Service
96 {
118  void start(string name, Ice::Communicator communicator, Ice::StringSeq args);
119 
125  void stop();
126 }
127 
137 {
146 
155 }
156 
164 interface ServiceManager
165 {
173  ["nonmutating", "cpp:const"] idempotent Ice::SliceChecksumDict getSliceChecksums();
174 
184  void startService(string service)
186 
196  void stopService(string service)
198 
206  void addObserver(ServiceObserver* observer);
207 
213  void shutdown();
214 }
215 
216 }
Ice::Communicator
The central object in Ice.
Definition: Communicator.ice:68
CommunicatorF.ice
IceBox::AlreadyStartedException
This exception is thrown if an attempt is made to start an already-started service.
Definition: IceBox.ice:67
BuiltinSequences.ice
IceBox::FailureException::reason
string reason
The reason for the failure.
Definition: IceBox.ice:57
Ice::StringSeq
sequence< string > StringSeq
A sequence of strings.
Definition: BuiltinSequences.ice:51
IceBox::ServiceObserver::servicesStopped
void servicesStopped(Ice::StringSeq services)
Receives the names of the services that were stopped.
IceBox::NoSuchServiceException
This exception is thrown if a service name does not refer to an existing service.
Definition: IceBox.ice:87
IceBox::ServiceManager::addObserver
void addObserver(ServiceObserver *observer)
Registers a new observer with the ServiceManager.
IceBox::Service
An application service managed by a ServiceManager.
Definition: IceBox.ice:96
IceBox::ServiceManager::shutdown
void shutdown()
Shut down all services.
IceBox::ServiceObserver
An Observer interface implemented by admin clients interested in the status of services.
Definition: IceBox.ice:137
IceBox::ServiceManager::getSliceChecksums
idempotent Ice::SliceChecksumDict getSliceChecksums()
Returns the checksums for the IceBox Slice definitions.
IceBox::ServiceManager
Administers a set of Service instances.
Definition: IceBox.ice:165
IceBox::FailureException
This exception is a general failure notification.
Definition: IceBox.ice:51
IceBox::AlreadyStoppedException
This exception is thrown if an attempt is made to stop an already-stopped service.
Definition: IceBox.ice:77
SliceChecksumDict.ice
IceBox::Service::stop
void stop()
Stop the service.
IceBox::ServiceManager::stopService
void stopService(string service)
Stop an individual service.
Ice::SliceChecksumDict
dictionary< string, string > SliceChecksumDict
A mapping from type IDs to Slice checksums.
Definition: SliceChecksumDict.ice:34
IceBox::Service::start
void start(string name, Ice::Communicator communicator, Ice::StringSeq args)
Start the service.
IceBox
IceBox is an application server specifically for Ice applications.
Definition: IceBox.ice:39
IceBox::ServiceManager::startService
void startService(string service)
Start an individual service.
IceBox::ServiceObserver::servicesStarted
void servicesStarted(Ice::StringSeq services)
Receives the names of the services that were started.
PropertiesF.ice