diff options
Diffstat (limited to 'cpp')
-rw-r--r-- | cpp/slice/IceGrid/Admin.ice | 41 | ||||
-rw-r--r-- | cpp/slice/IceGrid/Descriptor.ice | 2 | ||||
-rw-r--r-- | cpp/slice/IceGrid/Exception.ice | 4 | ||||
-rw-r--r-- | cpp/slice/IceGrid/Observer.ice | 24 | ||||
-rw-r--r-- | cpp/slice/IceGrid/Query.ice | 6 |
5 files changed, 40 insertions, 37 deletions
diff --git a/cpp/slice/IceGrid/Admin.ice b/cpp/slice/IceGrid/Admin.ice index 2cc654bc55f..9afe8468c9a 100644 --- a/cpp/slice/IceGrid/Admin.ice +++ b/cpp/slice/IceGrid/Admin.ice @@ -79,7 +79,7 @@ dictionary<string, Object*> StringObjectProxyDict; /** * - * Information on an Ice object. + * Information about an Ice object. * **/ struct ObjectInfo @@ -108,7 +108,7 @@ sequence<ObjectInfo> ObjectInfoSeq; /** * - * Information on an adapter registered with the &IceGrid; registry. + * Information about an adapter registered with the &IceGrid; registry. * **/ struct AdapterInfo @@ -122,7 +122,7 @@ struct AdapterInfo /** * - * The replica group id of the object adapter or empty if the + * The replica group id of the object adapter, or empty if the * adapter doesn't belong to a replica group. * **/ @@ -132,7 +132,7 @@ dictionary<string, AdapterInfo> AdapterInfoDict; /** * - * Information on a server managed by an IceGrid node. + * Information about a server managed by an &IceGrid; node. * **/ struct ServerInfo @@ -159,6 +159,11 @@ struct ServerInfo ServerDescriptor descriptor; }; +/** + * + * Information about an &IceGrid; node. + * + **/ struct NodeInfo { /** @@ -235,7 +240,7 @@ interface Admin { /** * - * Add an application to &IceGrid;. An application is a set of servers. + * Add an application to &IceGrid;. * * @param descriptor The application descriptor. * @@ -305,7 +310,7 @@ interface Admin /** * * Patch the given application data. If the patch argument is an - * empty string, all the application servers depending on patch + * empty string, all of the application's servers that depend on patch * data will be patched. * * @param name The application name. @@ -372,7 +377,7 @@ interface Admin * * Get a server's state. * - * @param id The id of the server. + * @param id The server id. * * @return The server state. * @@ -390,9 +395,9 @@ interface Admin * Get a server's system process id. The process id is operating * system dependent. * - * @param id The id of the server. + * @param id The server id. * - * @return The server process id. + * @return The server's process id. * * @throws ServerNotExistException Raised if the server doesn't exist. * @@ -407,10 +412,10 @@ interface Admin * * Enable or disable a server. A disabled server can't be started * on demand or administratively. The enable state of the server - * is not persistent, if the node is shutdown and restarted, the + * is not persistent: if the node is shutdown and restarted, the * server will be enabled by default. * - * @param id The id of the server. + * @param id The server id. * * @param enabled True to enable the server, false to disable it. * @@ -427,7 +432,7 @@ interface Admin * * Check if the server is enabled or disabled. * - * @param id The id of the server. + * @param id The server id. * * @throws ServerNotExistException Raised if the server doesn't * exist. @@ -443,7 +448,7 @@ interface Admin * * Start a server and wait for its activation. * - * @param id The id of the server. + * @param id The server id. * * @return True if the server was successfully started, false * otherwise. @@ -462,7 +467,7 @@ interface Admin * * Stop a server. * - * @param id The id of the server. + * @param id The server id. * * @throws ServerNotExistException Raised if the server doesn't * exist. @@ -478,7 +483,7 @@ interface Admin * * Patch a server. * - * @param id The id of the server. + * @param id The server id. * * @param shutdown If true, servers depending on the data to patch * will be shutdown if necessary. @@ -499,7 +504,7 @@ interface Admin * * Send signal to a server. * - * @param id The id of the server. + * @param id The server id. * * @param signal The signal, for example SIGTERM or 15. * @@ -518,9 +523,9 @@ interface Admin /** * - * Write message on server stdout or stderr + * Write message on server stdout or stderr. * - * @param id The id of the server. + * @param id The server id. * * @param message The message. * diff --git a/cpp/slice/IceGrid/Descriptor.ice b/cpp/slice/IceGrid/Descriptor.ice index 94fcc21b4e3..08f9ac22814 100644 --- a/cpp/slice/IceGrid/Descriptor.ice +++ b/cpp/slice/IceGrid/Descriptor.ice @@ -147,7 +147,7 @@ struct DbEnvDescriptor /** * - * The home of the database environment (i.e.: the directory where + * The home of the database environment (i.e., the directory where * the database files will be stored). If empty, the node will * provide a default database directory, otherwise the directory * must exist. diff --git a/cpp/slice/IceGrid/Exception.ice b/cpp/slice/IceGrid/Exception.ice index ef2f7cd87de..d164b68fbd4 100644 --- a/cpp/slice/IceGrid/Exception.ice +++ b/cpp/slice/IceGrid/Exception.ice @@ -113,7 +113,7 @@ exception DeploymentException **/ exception NodeUnreachableException { - /** The name of the node which is not reachable. */ + /** The name of the node that is not reachable. */ string name; /** The reason why the node couldn't be reached. */ @@ -132,7 +132,7 @@ exception BadSignalException /** * - * This exception is raised if the patching failed. + * This exception is raised if a patch failed. * **/ exception PatchException diff --git a/cpp/slice/IceGrid/Observer.ice b/cpp/slice/IceGrid/Observer.ice index 1661bd307fa..7591e07d95b 100644 --- a/cpp/slice/IceGrid/Observer.ice +++ b/cpp/slice/IceGrid/Observer.ice @@ -48,7 +48,7 @@ struct ServerDynamicInfo /** * - * Whether or not the server is enabled or disabled. + * Indicates whether the server is enabled. * **/ bool enabled; @@ -213,8 +213,8 @@ interface RegistryObserver * observer to communicate the current state of the registry to the * observer implementation. * - * @param serial The current serial of the registry database. This - * serial allows observers to make sure that their internal state + * @param serial The current serial number of the registry database. This + * serial number allows observers to make sure that their internal state * is synchronized with the registry. * * @param applications The applications currently registered with @@ -267,15 +267,15 @@ interface Session extends Glacier2::Session { /** * - * Keep alive the session. Clients should call this method - * regularily to ensure the server won't reap the session. + * Keep the session alive. Clients should call this method + * regularly to prevent the server from reaping the session. * **/ void keepAlive(); /** * - * Get the session timeout configure for the node. + * Get the session timeout configured for the node. * **/ nonmutating int getTimeout(); @@ -312,7 +312,7 @@ interface Session extends Glacier2::Session * Set the identities of the observer objects that will receive * notifications from the servers when the state of the registry * or nodes changes. This method should be used by clients which - * are using a bi-directional connection to communicate with the + * are using a bidirectional connection to communicate with the * session. * * @param registryObs The registry observer identity. @@ -324,8 +324,7 @@ interface Session extends Glacier2::Session /** * - * Acquires to registry exclusive lock to start updating the - * registry applications. + * Acquires an exclusive lock to start updating the registry applications. * * @return The current serial. * @@ -387,8 +386,7 @@ interface Session extends Glacier2::Session /** * - * Finish to update the registry and release the exclusive - * lock. + * Finish updating the registry and release the exclusive lock. * * @throws AccessDeniedException Raised if the session doesn't hold the * exclusive lock. @@ -404,9 +402,9 @@ interface SessionManager extends Glacier2::SessionManager * * Create a local session. * - * @param userId An identifier to identify the session user. + * @param userId Identifies the session user. * - * @return The proxy on the local session. + * @return The proxy of the local session. * **/ Session* createLocalSession(string userId); diff --git a/cpp/slice/IceGrid/Query.ice b/cpp/slice/IceGrid/Query.ice index 6020c98e194..ac7136517cf 100644 --- a/cpp/slice/IceGrid/Query.ice +++ b/cpp/slice/IceGrid/Query.ice @@ -66,10 +66,10 @@ interface Query /** * - * Find an object by type on the least loaded node. If the IceGrid - * registry can't figure out the node that hosts the object (e.g.: + * Find an object by type on the least loaded node. If the + * registry can't figure out the node that hosts the object (e.g., * if the object was registered with a direct proxy), the registry - * assumes the object is hosted on a node which has a load average + * assumes the object is hosted on a node that has a load average * of 1.0. * * @param type The object type. |