LibreOffice
LibreOffice 26.2 SDK API Reference
Toggle main menu visibility
Loading...
Searching...
No Matches
XConnection.idl
Go to the documentation of this file.
1
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2
/*
3
* This file is part of the LibreOffice project.
4
*
5
* This Source Code Form is subject to the terms of the Mozilla Public
6
* License, v. 2.0. If a copy of the MPL was not distributed with this
7
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
8
*
9
* This file incorporates work covered by the following license notice:
10
*
11
* Licensed to the Apache Software Foundation (ASF) under one or more
12
* contributor license agreements. See the NOTICE file distributed
13
* with this work for additional information regarding copyright
14
* ownership. The ASF licenses this file to you under the Apache
15
* License, Version 2.0 (the "License"); you may not use this file
16
* except in compliance with the License. You may obtain a copy of
17
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
18
*/
19
20
21
module
com
{ module sun { module star { module connection {
22
29
published
interface
XConnection
:
com::sun::star::uno::XInterface
30
{
31
50
long
read
( [out] sequence < byte > aReadBytes , [in]
long
nBytesToRead )
51
raises(
com::sun::star::io::IOException
);
52
59
void
write
( [in] sequence < byte > aData )
60
raises(
com::sun::star::io::IOException
);
61
62
65
void
flush
( )
66
raises(
com
::
sun
::
star
::
io
::IOException );
67
71
void
close
( )
72
raises(
com
::
sun
::
star
::
io
::IOException );
73
74
81
string
getDescription
();
82
};
83
84
};};};};
85
86
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::io::IOException
is thrown when an input or output error has occurred.
Definition
IOException.idl:27
com::sun::star::connection::XConnection
A bidirectional bytestream.
Definition
XConnection.idl:30
com::sun::star::connection::XConnection::close
void close()
Immediately terminates any ongoing read or write calls.
com::sun::star::connection::XConnection::read
long read([out] sequence< byte > aReadBytes, [in] long nBytesToRead)
reads a requested number of bytes from the connection.
com::sun::star::connection::XConnection::getDescription
string getDescription()
A unique string describing the connection.
com::sun::star::connection::XConnection::flush
void flush()
Empties all internal buffers.
com::sun::star::connection::XConnection::write
void write([in] sequence< byte > aData)
writes the given bytesequence to the stream.
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition
XInterface.idl:46
com::sun::star::io
General input/output interfaces.
Definition
AlreadyConnectedException.idl:22
com::sun::star
the module com::sun::star is the root module of the UNO API.
Definition
Ambiguous.idl:20
com::sun
Definition
Ambiguous.idl:20
com
Definition
Ambiguous.idl:20
com
sun
star
connection
XConnection.idl
Generated by
1.17.0