summaryrefslogtreecommitdiff
path: root/udkapi/com/sun/star/test/performance/XPerformanceTest.idl
blob: e44eabd05b2f4707cba33a44bd89cc4560ca425e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
/*************************************************************************
 *
 *  $RCSfile: XPerformanceTest.idl,v $
 *
 *  $Revision: 1.6 $
 *
 *  last change: $Author: dbo $ $Date: 2002-01-23 08:52:21 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (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.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_test_performance_XPerformanceTest_idl__
#define __com_sun_star_test_performance_XPerformanceTest_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

module com
{
module sun
{
module star
{
module test
{
module performance
{

/** struct of simple types to be carried
*/
struct SimpleTypes
{
    boolean                    Bool;
    char                       Char;
    byte                       Byte;
    short                      Short;
    unsigned short             UShort;
    long                       Long;
    unsigned long              ULong;
    hyper                      Hyper;
    unsigned hyper             UHyper;
    float                      Float;
    double                     Double;
};
/** struct ComplexTypes adding Sequence, String, Interface, Any to SimpleTypes
*/
struct ComplexTypes : SimpleTypes
{
    sequence< long >           Sequence;
    string                     String;
    com::sun::star::uno::XInterface Interface;
    any                        Any;
};

/** A performance test object has to be implemented in a special way, that:
    <ul>
    <li>queryInterface() execution times remain (nearly) static</li>
    <li>functions kept simple, thus there is (nearly) no execution time of the function itself</li>
    <li>no dynamic data is ever returned except of createObject(), so return 0, empty strings etc.</li>
    </ul>
    The interface is divided into three sections:
    <ul>
    <li>measuring asynchron/ synchron calls</li>
    <li>complex data calls with/out return value; in/out parameters</li>
    <li>single data types like long, float, string etc.</li>
    <li>method calls versa attribute calls</li>
    <li>raising RuntimeException</li>
    </ul>
*/
interface XPerformanceTest : com::sun::star::uno::XInterface
{
    [oneway] void async();
    void sync();

    ComplexTypes complex_in( [in] ComplexTypes aVal );
    ComplexTypes complex_inout( [inout] ComplexTypes aVal );

    [oneway] void complex_oneway( [in] ComplexTypes aVal );
    void complex_noreturn( [in] ComplexTypes aVal );

    XPerformanceTest createObject();

    [attribute] long                     Long_attr;
    [attribute] hyper                    Hyper_attr;
    [attribute] float                    Float_attr;
    [attribute] double                   Double_attr;
    [attribute] string                   String_attr;
    [attribute] com::sun::star::uno::XInterface Interface_attr;
    [attribute] any                      Any_attr;
    [attribute] sequence< com::sun::star::uno::XInterface > Sequence_attr;
    [attribute] ComplexTypes             Struct_attr;

    long                getLong();
    void                setLong( [in] long n );
    hyper               getHyper();
    void                setHyper( [in] hyper n );
    float               getFloat();
    void                setFloat( [in] float f );
    double              getDouble();
    void                setDouble( [in] double f );
    string              getString();
    void                setString( [in] string s );
    com::sun::star::uno::XInterface getInterface();
    void                setInterface( [in] com::sun::star::uno::XInterface x );
    any                 getAny();
    void                setAny( [in] any a );
    sequence< com::sun::star::uno::XInterface > getSequence();
    void                setSequence( [in] sequence< com::sun::star::uno::XInterface > seq );
    ComplexTypes        getStruct();
    void                setStruct( [in] ComplexTypes c );

    void raiseRuntimeException();
};

//=============================================================================

};
};
};
};
};

#endif