Struct dittolive_ditto::transport::Global

pub struct Global {
    pub sync_group: u32,
    pub routing_hint: u32,
}

Settings not associated with any specific type of transport.

Fields

sync_group: u32

The sync group for this device.

When peer-to-peer transports are enabled, all devices with the same App ID will normally form an interconnected mesh network. In some situations it may be desirable to have distinct groups of devices within the same app, so that connections will only be formed within each group. The sync_group parameter changes that group membership. A device can only ever be in one sync group, which by default is group 0. Up to 2^32 distinct group numbers can be used in an app.

This is an optimization, not a security control. If a connection is created manually, such as by specifying a connect transport, then devices from different sync groups will still sync as normal. If two groups of devices are intended to have access to different data sets, this must be enforced using Ditto’s permissions system.

routing_hint: u32

The routing hint for this device.

A routing hint is a performance tuning option which can improve the performance of applications that use large collections. Ditto will make a best effort to co-locate data for the same routing key. In most circumstances, this should substantially improve responsiveness of the Ditto Cloud.

The value of the routing hint is application specific - you are free to chose any value. Devices which you expect to operate on much the same data should be configured to use the same value.

A routing hint does not partition data. The value of the routing hint will not affect the data returned for a query. The routing hint only improves the efficiency of the Cloud’s ability to satisfy the query.

Trait Implementations

impl Clone for Global

fn clone(&self) -> Global

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Global

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Global

fn default() -> Global

Returns the “default value” for a type.

impl PartialEq<Global> for Global

fn eq(&self, other: &Global) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Global) -> bool

This method tests for !=.

impl Eq for Global

impl StructuralEq for Global

impl StructuralPartialEq for Global