diff options
Diffstat (limited to 'cpp')
-rw-r--r-- | cpp/slice/Ice/ObjectAdapter.ice | 11 | ||||
-rw-r--r-- | cpp/slice/Ice/Pickler.ice | 24 |
2 files changed, 29 insertions, 6 deletions
diff --git a/cpp/slice/Ice/ObjectAdapter.ice b/cpp/slice/Ice/ObjectAdapter.ice index d605540b4ea..077d444b77d 100644 --- a/cpp/slice/Ice/ObjectAdapter.ice +++ b/cpp/slice/Ice/ObjectAdapter.ice @@ -182,7 +182,7 @@ local interface ObjectAdapter * * <note><para>This operation does only try to lookup a Servant in * the Active Servant Map. It does not attempt to find a Servant - * via any installed [ServantLocator]s.</para></note> + * by using any installed [ServantLocator].</para></note> * * @param identity The identity of the Ice Object for which the * Servant should be returned. @@ -249,6 +249,13 @@ local interface ServantLocator * Servant Map. This must be done by the Servant Locator's * implementation, if this is desired. * + * <important><para>If you call [locate] from our own code, you + * must also call [finished] when you are done with using the + * Servant, provided that a non-null Servant was + * returned. Otherwise you will get undefined behavior if you use + * Servant Locators such as the + * [Freeze::Evictor].</para></important> + * * @param adapter The Object Adapter that calls the Servant * Locator. * @@ -258,7 +265,7 @@ local interface ServantLocator * @param operation The operation the Object Adapter is about to * call. * - * @param cookie A "cookie", which is returned to [finished]. + * @param cookie A "cookie", which will be passed to [finished]. * * @return The located Servant, or null if no suitable Servant has * been found. diff --git a/cpp/slice/Ice/Pickler.ice b/cpp/slice/Ice/Pickler.ice index aecc506d8b6..6da894dce45 100644 --- a/cpp/slice/Ice/Pickler.ice +++ b/cpp/slice/Ice/Pickler.ice @@ -14,19 +14,33 @@ module Ice { +/** + * + * A language-specific input stream type. For C++, a Slice + * [InputStream] is mapped to a C++ [std::istream]. + * + **/ native InputStream; + +/** + * + * A language-specific output stream type. For C++, a Slice + * [OutputStream] is mapped to a C++ [std::ostream]. + * + **/ native OutputStream; /** * - * A simple object serializer. Servants can be written to a native - * ioutput stream type, and read from a native input stream type. For - * C++, the output stream type is [std::ostream] and the input stream - * type is [std::istream]. + * A simple object serializer. Servants can be written to an + * [OutputStream] and read from an [InputStream]. * * <note><para>For more sophisticated object persistence, you should * use the Freeze module.</para></note> * + * @see InputStream + * @see OutputStream + * **/ local interface Pickler { @@ -39,6 +53,7 @@ local interface Pickler * @param out The output stream. * * @see unpickle + * @see OutputStream * **/ void pickle(Object servant, OutputStream out); @@ -55,6 +70,7 @@ local interface Pickler * @return The Servant that has been read from the input stream. * * @see pickle + * @see InputStream * @see ServantFactory * **/ |