Struct dittolive_ditto::transport::TransportConfig
source · [−]pub struct TransportConfig {
pub peer_to_peer: PeerToPeer,
pub connect: Connect,
pub listen: Listen,
pub global: Global,
}
Expand description
A configuration object specifying which network transports Ditto should use to sync data.
A Ditto
object comes with a default transport configuration where all
available peer-to-peer transports are enabled. You can customize this by
initializing a TransportConfig
, adjusting its properties, and supplying it
to set_transport_config()
on Ditto
.
When you initialize a TransportConfig
yourself it starts with all
transports disabled. You must enable each one directly.
Peer-to-peer transports will automatically discover peers in the vicinity
and create connections without any configuration. These are configured
inside the peer_to_peer
property. To turn each one on, set its enabled
property to true
.
To connect to a peer at a known location, such as a Ditto Big Peer, add its
address inside the connect
configuration. These are either host:port
strings for raw TCP sync, or a wss://…
URL for websockets.
The listen
configurations are for specific less common data sync
scenarios. Please read the documentation on the Ditto website for examples.
Incorrect use of listen
can result in insecure configurations.
Fields
peer_to_peer: PeerToPeer
connect: Connect
listen: Listen
global: Global
Implementations
sourceimpl TransportConfig
impl TransportConfig
pub fn new() -> Self
pub fn enable_all_peer_to_peer(&mut self)
Trait Implementations
sourceimpl Clone for TransportConfig
impl Clone for TransportConfig
sourcefn clone(&self) -> TransportConfig
fn clone(&self) -> TransportConfig
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresourceimpl Debug for TransportConfig
impl Debug for TransportConfig
sourceimpl Default for TransportConfig
impl Default for TransportConfig
sourcefn default() -> TransportConfig
fn default() -> TransportConfig
sourceimpl PartialEq<TransportConfig> for TransportConfig
impl PartialEq<TransportConfig> for TransportConfig
sourcefn eq(&self, other: &TransportConfig) -> bool
fn eq(&self, other: &TransportConfig) -> bool
impl Eq for TransportConfig
impl StructuralEq for TransportConfig
impl StructuralPartialEq for TransportConfig
Auto Trait Implementations
impl RefUnwindSafe for TransportConfig
impl Send for TransportConfig
impl Sync for TransportConfig
impl Unpin for TransportConfig
impl UnwindSafe for TransportConfig
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<T> CompatExt for T
impl<T> CompatExt for T
fn compat_ref(&self) -> Compat<&T>
fn compat_ref(&self) -> Compat<&T>
Compat
] adapter by shared reference. Read morefn compat_mut(&mut self) -> Compat<&mut T>
fn compat_mut(&mut self) -> Compat<&mut T>
Compat
] adapter by mutable reference. Read more