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
use std::sync::Arc;
use std::time::Duration;
use crate::{ClientOptions, Envelope};
/// The trait for transports.
///
/// A transport is responsible for sending events to Sentry. Custom implementations
/// can be created to use a different abstraction to send events. This is for instance
/// used for the test system.
pub trait Transport: Send + Sync + 'static {
/// Sends an [`Envelope`].
///
/// [`Envelope`]: struct.Envelope.html
fn send_envelope(&self, envelope: Envelope);
/// Flushes the transport queue if there is one.
///
/// If the queue was successfully drained, the return value should be
/// `true` or `false` if events were left in it.
fn flush(&self, timeout: Duration) -> bool {
let _timeout = timeout;
true
}
/// Instructs the Transport to shut down.
fn shutdown(&self, timeout: Duration) -> bool {
self.flush(timeout)
}
}
/// A factory creating transport instances.
///
/// Because options are potentially reused between different clients the
/// options do not actually contain a transport but a factory object that
/// can create transports instead.
///
/// The factory has a single method that creates a new arced transport.
/// Because transports can be wrapped in `Arc`s and those are clonable
/// any `Arc<Transport>` is also a valid transport factory. This for
/// instance lets you put a `Arc<TestTransport>` directly into the options.
///
/// This is automatically implemented for all closures optionally taking
/// options and returning a boxed factory.
pub trait TransportFactory: Send + Sync {
/// Given some options creates a transport.
fn create_transport(&self, options: &ClientOptions) -> Arc<dyn Transport>;
}
impl<F> TransportFactory for F
where
F: Fn(&ClientOptions) -> Arc<dyn Transport> + Clone + Send + Sync + 'static,
{
fn create_transport(&self, options: &ClientOptions) -> Arc<dyn Transport> {
(*self)(options)
}
}
impl<T: Transport> Transport for Arc<T> {
fn send_envelope(&self, envelope: Envelope) {
(**self).send_envelope(envelope)
}
fn shutdown(&self, timeout: Duration) -> bool {
(**self).shutdown(timeout)
}
}
impl<T: Transport> TransportFactory for Arc<T> {
fn create_transport(&self, options: &ClientOptions) -> Arc<dyn Transport> {
let _options = options;
self.clone()
}
}