pocketscion 0.1.0

A lightweight SCION network simulator
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

// Copyright 2025 Anapaya Systems
//
// Licensed 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
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//! PocketSCION network receivers.

use scion_proto::packet::ScionPacketRaw;

pub mod router_socket;
pub mod tunnel_gateway;

/// A simulated network receiver that can receive packets from the network simulation.
///
/// NOTE: Receivers **MUST NOT** try to lock the `SharedPocketScionState` in their
/// `receive_packet` method, as the network simulation is holding this lock during dispatch.
pub trait Receiver: Sync + Send {
    /// Callback called by the network simulation to deliver a packet to this receiver.
    fn receive_packet(&self, packet: ScionPacketRaw);
}