Fast RTPS  Version 2.4.1
Fast RTPS
dds-builtin_types.idl
1 module DDS {
2  @extensibility(APPENDABLE)
3  struct _String {
4  string value;
5  };
6 
7  interface StringDataWriter : DataWriter {
8  /* This interface shall instantiate the type FooDataWriter defined by
9  * the DDS specification where "Foo" is an unbounded string.
10  */
11  };
12 
13  interface StringDataReader : DataReader {
14  /* This interface shall instantiate the type FooDataReader defined by
15  * the DDS specification where "Foo" is an unbounded string.
16  */
17  };
18 
20  /* This interface shall instantiate the type FooTypeSupport
21  * defined by the DDS specification where "Foo" is an unbounded
22  * string.
23  */
24  };
25 
26  @extensibility(APPENDABLE)
27  struct KeyedString {
28  @key string key;
29  string value;
30  };
31 
32  typedef sequence<KeyedString> KeyedStringSeq;
33 
34  interface KeyedStringDataWriter : DataWriter {
35  /* This interface shall instantiate the type FooDataWriter defined by
36  * the DDS specification where "Foo" is KeyedString. It also defines
37  * the operations below.
38  */
39  InstanceHandle_t register_instance_w_key( in string key);
40  InstanceHandle_t register_instance_w_key_w_timestamp( in string key, in Time_t source_timestamp);
41 
42  ReturnCode_t unregister_instance_w_key( in string key);
43  ReturnCode_t unregister_instance_w_key_w_timestamp( in string key, in Time_t source_timestamp);
44 
45  ReturnCode_t write_string_w_key( in string key, in string str, in InstanceHandle_t handle);
46  ReturnCode_t write_string_w_key_w_timestamp( in string key, in string str, in InstanceHandle_t handle, in Time_t source_timestamp);
47 
48  ReturnCode_t dispose_w_key( in string key);
49  ReturnCode_t dispose_w_key_w_timestamp( in string key, in Time_t source_timestamp);
50 
51  ReturnCode_t get_key_value_w_key( inout string key, in InstanceHandle_t handle);
52 
53  InstanceHandle_t lookup_instance_w_key( in string key);
54  };
55 
56  interface KeyedStringDataReader : DataReader {
57  /* This interface shall instantiate the type FooDataReader defined by
58  * the DDS specification where "Foo" is KeyedString.
59  */
60  };
61 
63  /* This interface shall instantiate the type FooTypeSupport
64  * defined by the DDS specification where "Foo" is KeyedString.
65  */
66  };
67 
68 
69  @extensibility(APPENDABLE)
70  struct Bytes {
71  ByteSeq value;
72  };
73  typedef sequence<Bytes> BytesSeq;
74 
75  interface BytesDataWriter : DataWriter {
76  /* This interface shall instantiate the type FooDataWriter defined by
77  * the DDS specification where "Foo" is an unbounded sequence of
78  * bytes (octets). It also defines the operations below.
79  */
80  ReturnCode_t write_w_bytes( in ByteArray bytes, in long offset, in long length, in InstanceHandle_t handle);
81  ReturnCode_t write_w_bytes_w_timestamp( in ByteArray bytes, in long offset, in long length, in InstanceHandle_t handle, in Time_t source_timestamp);
82  };
83 
84  interface BytesDataReader : DataReader {
85  /* This interface shall instantiate the type FooDataReader defined by
86  * the DDS specification where "Foo" is Bytes.
87  */
88  };
89 
91  /* This interface shall instantiate the type FooTypeSupport
92  * defined by the DDS specification where "Foo" is Bytes.
93  */
94  };
95 
96 
97  @extensibility(APPENDABLE)
98  struct KeyedBytes {
99  @key string key;
100  ByteSeq value;
101  };
102  typedef sequence<KeyedBytes> KeyedBytesSeq;
103 
104  interface KeyedBytesDataWriter : DataWriter {
105  /* This interface shall instantiate the type FooDataWriter defined by
106  * the DDS specification where "Foo" is KeyedBytes.
107  * It also defines the operations below.
108  */
109  InstanceHandle_t register_instance_w_key( in string key);
110  InstanceHandle_t register_instance_w_key_w_timestamp( in string key, in Time_t source_timestamp);
111 
112  ReturnCode_t unregister_instance_w_key( in string key);
113  ReturnCode_t unregister_instance_w_key_w_timestamp( in string key, in Time_t source_timestamp);
114 
115  ReturnCode_t write_bytes_w_key( in string key, in ByteArray bytes, in long offset, in long length, in InstanceHandle_t handle);
116  ReturnCode_t write_bytes_w_key_w_timestamp( in string key, in ByteArray bytes, in long offset, in long length, in InstanceHandle_t handle, in Time_t source_timestamp);
117 
118  ReturnCode_t dispose_w_key( in string key);
119  ReturnCode_t dispose_w_key_w_timestamp( in string key, in Time_t source_timestamp);
120 
121  ReturnCode_t get_key_value_w_key( inout string key, in InstanceHandle_t handle);
122 
123  InstanceHandle_t lookup_instance_w_key( in string key);
124  };
125 
126  interface KeyedBytesDataReader : DataReader {
127  /* This interface shall instantiate the type FooDataReader defined by
128  * the DDS specification where "Foo" is KeyedBytes.
129  */
130  };
131 
133  /* This interface shall instantiate the type FooTypeSupport
134  * defined by the DDS specification where "Foo" is KeyedBytes.
135  */
136  };
137 }; // end module DDS
Definition: dds-builtin_types.idl:84
Definition: dds-builtin_types.idl:75
ReturnCode_t write_w_bytes_w_timestamp(in ByteArray bytes, in long offset, in long length, in InstanceHandle_t handle, in Time_t source_timestamp)
ReturnCode_t write_w_bytes(in ByteArray bytes, in long offset, in long length, in InstanceHandle_t handle)
Definition: dds-builtin_types.idl:90
Definition: dds-builtin_types.idl:126
Definition: dds-builtin_types.idl:104
InstanceHandle_t register_instance_w_key(in string key)
ReturnCode_t unregister_instance_w_key_w_timestamp(in string key, in Time_t source_timestamp)
ReturnCode_t write_bytes_w_key(in string key, in ByteArray bytes, in long offset, in long length, in InstanceHandle_t handle)
ReturnCode_t dispose_w_key_w_timestamp(in string key, in Time_t source_timestamp)
ReturnCode_t unregister_instance_w_key(in string key)
ReturnCode_t dispose_w_key(in string key)
ReturnCode_t write_bytes_w_key_w_timestamp(in string key, in ByteArray bytes, in long offset, in long length, in InstanceHandle_t handle, in Time_t source_timestamp)
InstanceHandle_t lookup_instance_w_key(in string key)
InstanceHandle_t register_instance_w_key_w_timestamp(in string key, in Time_t source_timestamp)
ReturnCode_t get_key_value_w_key(inout string key, in InstanceHandle_t handle)
Definition: dds-builtin_types.idl:132
Definition: dds-builtin_types.idl:56
Definition: dds-builtin_types.idl:34
InstanceHandle_t register_instance_w_key(in string key)
ReturnCode_t write_string_w_key_w_timestamp(in string key, in string str, in InstanceHandle_t handle, in Time_t source_timestamp)
ReturnCode_t unregister_instance_w_key_w_timestamp(in string key, in Time_t source_timestamp)
ReturnCode_t write_string_w_key(in string key, in string str, in InstanceHandle_t handle)
ReturnCode_t dispose_w_key_w_timestamp(in string key, in Time_t source_timestamp)
ReturnCode_t unregister_instance_w_key(in string key)
ReturnCode_t dispose_w_key(in string key)
InstanceHandle_t lookup_instance_w_key(in string key)
InstanceHandle_t register_instance_w_key_w_timestamp(in string key, in Time_t source_timestamp)
ReturnCode_t get_key_value_w_key(inout string key, in InstanceHandle_t handle)
Definition: dds-builtin_types.idl:62
Definition: dds-builtin_types.idl:13
Definition: dds-builtin_types.idl:7
Definition: dds-builtin_types.idl:19
Definition: dds-language_binding.idl:27
Definition: dds-builtin_types.idl:1
sequence< Bytes > BytesSeq
Definition: dds-builtin_types.idl:72
sequence< KeyedBytes > KeyedBytesSeq
Definition: dds-builtin_types.idl:101
sequence< octet > ByteSeq
Definition: dds-language_binding.idl:175
sequence< KeyedString > KeyedStringSeq
Definition: dds-builtin_types.idl:30
Definition: BuiltinAnnotationsTypeObject.h:73