Struct sorceress::server::Notify

pub struct Notify { /* fields omitted */ }

Register to receive notifications from server.

Asynchronous. Replies to the sender with a Reply::NotifyDone message containing a client ID and an optional max_logins parameter when complete. If this client has registered for notifications before, the client ID may be the same. Otherwise it will be a new one. Clients can use this ID in multi-client situations to avoid conflicts when allocating resources such as node IDs, bus indices, and buffer numbers. max_logins is only returned when the client ID argument is supplied in this command.

Implementations

impl Notify

pub fn new(setting: NotifySetting) -> Notify

Creates a new Notify command.

Arguments

• setting - If you give NotifySetting::Start, the server will remember your return address and send you notifications. If you give NotifySetting::Stop, the server will stop sending notifications to your address.

pub fn client_id(self, client_id: i32) -> Notify

Set the optional client ID.

Trait Implementations

impl AsyncCommand for Notify

impl Clone for Notify

fn clone(&self) -> Notify

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Command for Notify

impl Debug for Notify

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

Formats the value using the given formatter.

impl PartialEq<Notify> for Notify

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

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

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

This method tests for !=.

impl PartialOrd<Notify> for Notify

fn partial_cmp(&self, other: &Notify) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Notify