/* -*- 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 .
 */



module com {  module sun {  module star {  module io {

/** This is the basic interface to write data to a stream.
    <p>
    See the <a href="http://udk.openoffice.org/common/man/concept/streams.html">
    streaming document</a> for further information on chaining and piping streams.
 */
published interface XOutputStream: com::sun::star::uno::XInterface
{
    /** writes the whole sequence to the stream. (blocking call)
     */
    void writeBytes( [in] sequence<byte> aData )
            raises( com::sun::star::io::NotConnectedException,
                    com::sun::star::io::BufferSizeExceededException,
                    com::sun::star::io::IOException);

    /** flushes out of the stream any data that may exist in buffers.

        <p>The semantics of this method are rather vague.  See
        com::sun::star::io::XAsyncOutputMonitor::waitForCompletion()
        for a similar method
        with very specific semantics, that is useful in certain scenarios.</p>
     */
    void flush()
            raises( com::sun::star::io::NotConnectedException,
                    com::sun::star::io::BufferSizeExceededException,
                    com::sun::star::io::IOException);

    /** gets called to indicate that all data has been written.

        <p>If this method has not yet been called, no attached
        XInputStream receives an EOF signal. No further
        bytes may be written after this method has been called.</p>
     */
    void closeOutput()
            raises( com::sun::star::io::NotConnectedException,
                    com::sun::star::io::BufferSizeExceededException,
                    com::sun::star::io::IOException);

};


}; }; }; };

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */