summaryrefslogtreecommitdiffstats
path: root/udkapi/com/sun/star/io/ObjectInputStream.idl
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--udkapi/com/sun/star/io/ObjectInputStream.idl87
1 files changed, 87 insertions, 0 deletions
diff --git a/udkapi/com/sun/star/io/ObjectInputStream.idl b/udkapi/com/sun/star/io/ObjectInputStream.idl
new file mode 100644
index 000000000..02f9faac4
--- /dev/null
+++ b/udkapi/com/sun/star/io/ObjectInputStream.idl
@@ -0,0 +1,87 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_io_ObjectInputStream_idl__
+#define __com_sun_star_io_ObjectInputStream_idl__
+
+#include <com/sun/star/io/XObjectInputStream.idl>
+
+#include <com/sun/star/io/XActiveDataSink.idl>
+
+#include <com/sun/star/io/XConnectable.idl>
+
+#include <com/sun/star/io/XMarkableStream.idl>
+
+
+
+ module com { module sun { module star { module io {
+
+/** is a stream which allows reading the data of persistent objects.
+
+ <p>Implementations of this service must fulfill the specifications of the
+ DataInputStream service. It must be chained to an
+ XMarkableStream. Therefore, it provides the
+ XMarkableStream interface, and delegates the calls to the
+ chained object. </p>
+ <p>The written objects are held until this instance is destroyed.
+ The references to the objects are read as four-byte integers.
+ Data format reads:</p>
+
+ <pre>
+ short InfoLength
+ long ObjectReference // 0 indicates no object
+ UTF ServiceName // length of 0 indicates this is only a reference
+ long ObjectLength // 0 if it is a reference or no object, otherwise the len of the object data
+ Object ObjectData // the data of the object
+ ... // skipping additional data
+ </pre>
+
+ @note
+ <ul>
+ <li>-thread safe</li>
+ <li>-allow buffer size is 2 ^ 31 -1</li>
+ <li>-maximum object reference identifier must be the number of objects. </li>
+ <li>-object reference identifier 0 indicates no object</li>
+ <li>-skip addition data</li>
+ <li>-set the stream position behind the object data</li>
+ </ul>
+ */
+published service ObjectInputStream
+{
+ /** allows to read the data from the stream.
+ */
+ interface com::sun::star::io::XObjectInputStream;
+
+ /** allows to set the underlying inputstream */
+ interface com::sun::star::io::XActiveDataSink;
+
+ /** allows to navigate via a chain of streams */
+ interface com::sun::star::io::XConnectable;
+
+ /** allows to set marks within the stream. The implementation
+ may forward calls to this interface to a chained markablestream. */
+ interface com::sun::star::io::XMarkableStream;
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */