zerodds-corba-iiop 1.0.0-rc.1

OMG CORBA 3.3 Part 2 §14 + §15.7 + §15.9 — voller IIOP-TCP-Transport-Stack: ProfileBody (alle 4 Versionen 1.0-1.3 inkl. TaggedComponents), Connection / Connector / Acceptor mit thread-safer Connection-Reuse, Bidirectional-GIOP. no_std + alloc.
Documentation
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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
// SPDX-License-Identifier: Apache-2.0
// Copyright 2026 ZeroDDS Contributors

//! IIOP-Connection — TCP-Stream-Wrapper mit GIOP-Message-IO.

use std::io::{BufReader, BufWriter};
use std::net::{Shutdown, SocketAddr, TcpStream};
use std::sync::Arc;
use std::time::Duration;

use zerodds_cdr::Endianness;
use zerodds_corba_ccm::orb_extensions::{
    ClientInterceptionPoint, InterceptorRegistry, ServerInterceptionPoint,
};
use zerodds_corba_giop::{Message, Version};

use crate::error::IiopError;
use crate::framing::{read_giop_message, write_giop_message};

/// IIOP-Connection — wraps eine `TcpStream` + Buffered-Reader/Writer.
///
/// `Connection` ist nicht `Clone` — fuer Sharing-Szenarien (z.B.
/// pro-Connection-Worker-Thread mit getrennten Reader/Writer-Halves)
/// nutzt der Caller [`std::net::TcpStream::try_clone`] auf dem inneren
/// Stream via `peer_addr()`/`local_addr()` und konstruiert eine
/// neue `Connection`.
pub struct Connection {
    reader: BufReader<TcpStream>,
    writer: BufWriter<TcpStream>,
    peer: SocketAddr,
    local: SocketAddr,
    /// Spec §16 Portable Interceptors — wenn gesetzt, walked
    /// `write_message`/`read_message` die Pipeline an den
    /// passenden Points (`SendRequest`/`ReceiveReply` Client-Side
    /// bzw. `ReceiveRequest`/`SendReply` Server-Side).
    interceptors: Option<Arc<InterceptorRegistry>>,
}

impl Connection {
    /// Wraps eine bestehende `TcpStream`.
    ///
    /// # Errors
    /// IO-Fehler beim Auslesen der Peer/Local-Addresses oder beim
    /// `try_clone` fuer Reader+Writer-Half.
    pub fn from_stream(stream: TcpStream) -> Result<Self, IiopError> {
        let peer = stream.peer_addr()?;
        let local = stream.local_addr()?;
        // Wir splitten via try_clone, sodass Reader und Writer
        // unabhaengige BufReader/BufWriter haben koennen. TCP-Stream-
        // Halves teilen denselben Socket; das ist Standard-Pattern.
        let reader_stream = stream.try_clone()?;
        let writer_stream = stream;
        Ok(Self {
            reader: BufReader::new(reader_stream),
            writer: BufWriter::new(writer_stream),
            peer,
            local,
            interceptors: None,
        })
    }

    /// Spec §16.4.x — installiert eine [`InterceptorRegistry`] fuer
    /// diese Connection. Subsequent `write_message`/`read_message`
    /// walken die Pipeline an den passenden Points.
    #[must_use]
    pub fn with_interceptors(mut self, registry: Arc<InterceptorRegistry>) -> Self {
        self.interceptors = Some(registry);
        self
    }

    /// Liefert die aktive Interceptor-Registry, falls eine installiert
    /// ist.
    #[must_use]
    pub fn interceptors(&self) -> Option<&Arc<InterceptorRegistry>> {
        self.interceptors.as_ref()
    }

    /// Spec §16.4.2 — walked Client-Pipeline am Point `point` mit
    /// Operation-Namen `op`. Wenn keine Registry installiert ist,
    /// no-op.
    pub fn run_client_pipeline(&self, point: ClientInterceptionPoint, op: &str) {
        if let Some(r) = &self.interceptors {
            r.walk_client(point, op);
        }
    }

    /// Spec §16.4.3 — walked Server-Pipeline.
    pub fn run_server_pipeline(&self, point: ServerInterceptionPoint, op: &str) {
        if let Some(r) = &self.interceptors {
            r.walk_server(point, op);
        }
    }

    /// Setzt den Read-Timeout.
    ///
    /// # Errors
    /// IO-Fehler.
    pub fn set_read_timeout(&self, timeout: Option<Duration>) -> Result<(), IiopError> {
        self.reader.get_ref().set_read_timeout(timeout)?;
        Ok(())
    }

    /// Setzt den Write-Timeout.
    ///
    /// # Errors
    /// IO-Fehler.
    pub fn set_write_timeout(&self, timeout: Option<Duration>) -> Result<(), IiopError> {
        self.writer.get_ref().set_write_timeout(timeout)?;
        Ok(())
    }

    /// Aktiviert/deaktiviert TCP-Nodelay (Nagle-Algorithmus).
    ///
    /// Default in CORBA-Deployments ist `true` (kein Nagle), weil
    /// GIOP-Roundtrip-Latency dominanter Faktor ist.
    ///
    /// # Errors
    /// IO-Fehler.
    pub fn set_nodelay(&self, nodelay: bool) -> Result<(), IiopError> {
        self.writer.get_ref().set_nodelay(nodelay)?;
        Ok(())
    }

    /// Liefert die Peer-Address.
    #[must_use]
    pub fn peer_addr(&self) -> SocketAddr {
        self.peer
    }

    /// Liefert die Local-Address.
    #[must_use]
    pub fn local_addr(&self) -> SocketAddr {
        self.local
    }

    /// Liest eine GIOP-Message vom Stream.
    ///
    /// Walkt die Server-Pipeline an `ReceiveRequest` (fuer eingehende
    /// `Request`-Messages) bzw. die Client-Pipeline an `ReceiveReply`
    /// (fuer eingehende `Reply`-Messages), wenn eine
    /// `InterceptorRegistry` installiert ist (Spec §16.4.2/§16.4.3).
    ///
    /// # Errors
    /// `IiopError::Closed` bei sauberem EOF; sonst `Io`/`Giop`.
    pub fn read_message(&mut self) -> Result<Message, IiopError> {
        let msg = read_giop_message(&mut self.reader)?;
        if let Some(r) = &self.interceptors {
            match &msg {
                Message::Request(req) => {
                    r.walk_server(ServerInterceptionPoint::ReceiveRequest, &req.operation);
                }
                Message::Reply(_) => {
                    // Op-Name ist im Reply nicht enthalten; wir nutzen
                    // den Spec-konformen leeren Marker. Caller mit
                    // Op-Tracking kann `run_client_pipeline` direkt
                    // mit dem Op-Namen aufrufen.
                    r.walk_client(ClientInterceptionPoint::ReceiveReply, "");
                }
                _ => {}
            }
        }
        Ok(msg)
    }

    /// Schreibt eine GIOP-Message auf den Stream.
    ///
    /// Walkt die Client-Pipeline an `SendRequest` (fuer ausgehende
    /// `Request`-Messages) bzw. die Server-Pipeline an `SendReply`
    /// (fuer ausgehende `Reply`-Messages), wenn eine
    /// `InterceptorRegistry` installiert ist (Spec §16.4.2/§16.4.3).
    ///
    /// # Errors
    /// IO- oder GIOP-Fehler.
    pub fn write_message(
        &mut self,
        version: Version,
        endianness: Endianness,
        more_fragments: bool,
        msg: &Message,
    ) -> Result<(), IiopError> {
        if let Some(r) = &self.interceptors {
            match msg {
                Message::Request(req) => {
                    r.walk_client(ClientInterceptionPoint::SendRequest, &req.operation);
                }
                Message::Reply(_) => {
                    r.walk_server(ServerInterceptionPoint::SendReply, "");
                }
                _ => {}
            }
        }
        write_giop_message(&mut self.writer, version, endianness, more_fragments, msg)
    }

    /// Schliesst die Connection ordentlich (TCP-FIN).
    ///
    /// # Errors
    /// IO-Fehler.
    pub fn shutdown(&mut self) -> Result<(), IiopError> {
        // Writer flushen, dann beide Halves shut.
        let _ = std::io::Write::flush(&mut self.writer);
        self.writer.get_ref().shutdown(Shutdown::Both)?;
        Ok(())
    }
}

#[cfg(test)]
#[allow(clippy::expect_used, clippy::unwrap_used, clippy::panic)]
mod tests {
    use super::*;
    use std::net::{TcpListener, TcpStream};
    use std::thread;
    use zerodds_corba_giop::{
        CloseConnection, Message, ReplyStatusType, ServiceContextList, TargetAddress,
    };

    fn make_test_pair() -> (Connection, Connection) {
        let listener = TcpListener::bind("127.0.0.1:0").unwrap();
        let server_addr = listener.local_addr().unwrap();
        let acceptor = thread::spawn(move || {
            let (stream, _) = listener.accept().unwrap();
            Connection::from_stream(stream).unwrap()
        });
        let client_stream = TcpStream::connect(server_addr).unwrap();
        let client = Connection::from_stream(client_stream).unwrap();
        let server = acceptor.join().unwrap();
        (client, server)
    }

    #[test]
    fn round_trip_request_reply() {
        let (mut client, mut server) = make_test_pair();
        client.set_nodelay(true).unwrap();
        server.set_nodelay(true).unwrap();

        // Client sendet Request.
        let request = Message::Request(zerodds_corba_giop::Request {
            request_id: 1,
            response_flags: zerodds_corba_giop::ResponseFlags::SYNC_WITH_TARGET,
            target: TargetAddress::Key(alloc::vec![0xab]),
            operation: "echo".into(),
            requesting_principal: None,
            service_context: ServiceContextList::default(),
            body: alloc::vec![1, 2, 3, 4],
        });
        client
            .write_message(Version::V1_2, Endianness::Big, false, &request)
            .unwrap();
        // Server liest.
        let received = server.read_message().unwrap();
        assert_eq!(received, request);

        // Server antwortet.
        let reply = Message::Reply(zerodds_corba_giop::Reply {
            request_id: 1,
            reply_status: ReplyStatusType::NoException,
            service_context: ServiceContextList::default(),
            body: alloc::vec![0xff],
        });
        server
            .write_message(Version::V1_2, Endianness::Big, false, &reply)
            .unwrap();
        let client_received = client.read_message().unwrap();
        assert_eq!(client_received, reply);
    }

    #[test]
    fn shutdown_propagates_eof_to_peer() {
        let (mut client, mut server) = make_test_pair();
        // Client schliesst.
        client.shutdown().unwrap();
        // Server liest -> Closed.
        let err = server.read_message().unwrap_err();
        assert!(matches!(err, IiopError::Closed));
    }

    // §16 Portable Interceptors Wire-up

    use std::sync::Mutex;
    use zerodds_corba_ccm::orb_extensions::{
        ClientRequestInterceptor, IorInterceptor, ServerRequestInterceptor,
    };

    struct RecordingClient {
        events: Arc<Mutex<Vec<(ClientInterceptionPoint, String)>>>,
    }
    impl ClientRequestInterceptor for RecordingClient {
        fn name(&self) -> &str {
            "recording-client"
        }
        fn intercept(&self, point: ClientInterceptionPoint, op: &str) {
            if let Ok(mut g) = self.events.lock() {
                g.push((point, op.to_string()));
            }
        }
    }

    struct RecordingServer {
        events: Arc<Mutex<Vec<(ServerInterceptionPoint, String)>>>,
    }
    impl ServerRequestInterceptor for RecordingServer {
        fn name(&self) -> &str {
            "recording-server"
        }
        fn intercept(&self, point: ServerInterceptionPoint, op: &str) {
            if let Ok(mut g) = self.events.lock() {
                g.push((point, op.to_string()));
            }
        }
    }

    struct ComponentTagIor;
    impl IorInterceptor for ComponentTagIor {
        fn name(&self) -> &str {
            "tagger"
        }
        fn establish_components(&self) -> Vec<u32> {
            // Spec §13.6 — TAG_ORB_TYPE als Marker-Tag.
            alloc::vec![0x4F4D_4730]
        }
    }

    #[test]
    fn pipeline_walks_client_send_request() {
        let events = Arc::new(Mutex::new(Vec::new()));
        let mut registry = InterceptorRegistry::new();
        registry.add_client(Arc::new(RecordingClient {
            events: events.clone(),
        }) as Arc<dyn ClientRequestInterceptor>);
        let registry = Arc::new(registry);

        let (client, server) = make_test_pair();
        let mut client = client.with_interceptors(registry.clone());
        let mut server = server;
        client.set_nodelay(true).unwrap();
        server.set_nodelay(true).unwrap();

        let request = Message::Request(zerodds_corba_giop::Request {
            request_id: 7,
            response_flags: zerodds_corba_giop::ResponseFlags::SYNC_WITH_TARGET,
            target: TargetAddress::Key(alloc::vec![0xab]),
            operation: "do_work".into(),
            requesting_principal: None,
            service_context: ServiceContextList::default(),
            body: alloc::vec![],
        });
        client
            .write_message(Version::V1_2, Endianness::Big, false, &request)
            .unwrap();
        let _ = server.read_message().unwrap();

        let g = events.lock().unwrap();
        assert_eq!(g.len(), 1);
        assert_eq!(g[0].0, ClientInterceptionPoint::SendRequest);
        assert_eq!(g[0].1, "do_work");
    }

    #[test]
    fn pipeline_walks_server_receive_request() {
        let events = Arc::new(Mutex::new(Vec::new()));
        let mut registry = InterceptorRegistry::new();
        registry.add_server(Arc::new(RecordingServer {
            events: events.clone(),
        }) as Arc<dyn ServerRequestInterceptor>);
        let registry = Arc::new(registry);

        let (client, server) = make_test_pair();
        let mut server = server.with_interceptors(registry.clone());
        let mut client = client;
        client.set_nodelay(true).unwrap();
        server.set_nodelay(true).unwrap();

        let request = Message::Request(zerodds_corba_giop::Request {
            request_id: 9,
            response_flags: zerodds_corba_giop::ResponseFlags::SYNC_WITH_TARGET,
            target: TargetAddress::Key(alloc::vec![0xcd]),
            operation: "echo".into(),
            requesting_principal: None,
            service_context: ServiceContextList::default(),
            body: alloc::vec![1, 2, 3],
        });
        client
            .write_message(Version::V1_2, Endianness::Big, false, &request)
            .unwrap();
        let _ = server.read_message().unwrap();

        let g = events.lock().unwrap();
        assert_eq!(g.len(), 1);
        assert_eq!(g[0].0, ServerInterceptionPoint::ReceiveRequest);
        assert_eq!(g[0].1, "echo");
    }

    #[test]
    fn ior_interceptor_fires_on_walk_ior() {
        let mut registry = InterceptorRegistry::new();
        registry.add_ior(Arc::new(ComponentTagIor) as Arc<dyn IorInterceptor>);
        let tags = registry.walk_ior();
        assert_eq!(tags, alloc::vec![0x4F4D_4730]);
    }

    #[test]
    fn close_connection_message_round_trip() {
        let (mut client, mut server) = make_test_pair();
        client
            .write_message(
                Version::V1_2,
                Endianness::Big,
                false,
                &Message::CloseConnection(CloseConnection),
            )
            .unwrap();
        let received = server.read_message().unwrap();
        assert!(matches!(received, Message::CloseConnection(_)));
    }
}