From ed5640d8b587fbcfed7dd7967f3de04b37a76f26 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 7 Apr 2024 11:06:44 +0200 Subject: Adding upstream version 4:7.4.7. Signed-off-by: Daniel Baumann --- udkapi/com/sun/star/io/ObjectInputStream.idl | 87 ++++++++++++++++++++++++++++ 1 file changed, 87 insertions(+) create mode 100644 udkapi/com/sun/star/io/ObjectInputStream.idl (limited to 'udkapi/com/sun/star/io/ObjectInputStream.idl') 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 + +#include + +#include + +#include + + + + module com { module sun { module star { module io { + +/** is a stream which allows reading the data of persistent objects. + +

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.

+

The written objects are held until this instance is destroyed. + The references to the objects are read as four-byte integers. + Data format reads:

+ +
+    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
+    
+ + @note +
    +
  • -thread safe
  • +
  • -allow buffer size is 2 ^ 31 -1
  • +
  • -maximum object reference identifier must be the number of objects.
  • +
  • -object reference identifier 0 indicates no object
  • +
  • -skip addition data
  • +
  • -set the stream position behind the object data
  • +
+ */ +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: */ -- cgit v1.2.3