Skip to main content

ControlMessage

Enum ControlMessage 

Source
pub enum ControlMessage {
Show 32 variants MediaResourceNotification(MediaResourceNotification), PortResponse(PortEndpoint), StartSessionTransmission(SessionTransmission), StopSessionTransmission(SessionTransmission), ClearConference { conference_id: ConferenceId, service_number: u32, }, CreateConferenceRequest(CreateConferenceRequest), DeleteConferenceRequest { conference_id: ConferenceId, }, ModifyConferenceRequest(ModifyConferenceRequest), AddParticipantRequest(AddParticipantRequest), DropParticipantRequest { conference_id: ConferenceId, call_reference: CallReference, }, AuditConferenceRequest, AuditParticipantRequest { conference_id: ConferenceId, }, ChangeParticipantRequest(ChangeParticipantRequest), CreateConferenceResponse(CreateConferenceResponse), DeleteConferenceResponse { conference_id: ConferenceId, result: DeleteConferenceResult, }, ModifyConferenceResponse(ModifyConferenceResponse), AddParticipantResponse(AddParticipantResponse), AuditConferenceResponse(AuditConferenceResponse), AuditParticipantResponse(AuditParticipantResponse), StartAnnouncement { announcements: Vec<AnnouncementEntry>, end_of_ack: EndOfAnnouncementAck, conference_id: u32, matrix_conference_party_ids: Vec<u32>, hearing_conference_party_mask: u32, play_mode: AnnouncementPlayMode, }, StopAnnouncement { conference_id: u32, }, AnnouncementFinish { conference_id: u32, play_status: AnnouncementPlayStatus, }, QosReservationNotify { flow: QosFlow, direction: QosDirection, }, QosErrorNotify { flow: QosFlow, direction: QosDirection, error_code: QosErrorCode, failure_node: Ipv4Addr, rsvp_error_code: RsvpErrorCode, rsvp_error_subcode: u32, rsvp_error_flags: u32, }, QosListen { flow: QosFlow, reservation_style: QosReservationStyle, maximum_retries: u32, retry_timer: u32, confirmation_required: bool, preemption_priority: u32, defending_priority: u32, traffic: QosTrafficSpecification, application: QosApplicationIdentifier, }, QosPath { flow: QosFlow, reservation_style: QosReservationStyle, maximum_retries: u32, retry_timer: u32, preemption_priority: u32, defending_priority: u32, traffic: QosTrafficSpecification, application: QosApplicationIdentifier, }, QosTeardown { flow: QosFlow, direction: QosDirection, }, UpdateDscp { flow: QosFlow, dscp: u8, }, QosModify { flow: QosFlow, direction: QosDirection, traffic: QosTrafficSpecification, application: QosApplicationIdentifier, }, MessageWaitingNotification(MessageWaitingNotification), MessageWaitingResponse { target_number: String, result: MessageWaitingResult, }, KnownOpaque(KnownOpaqueMessage),
}
Expand description

Messages exchanged with conference/media-resource/call-control peers.

These IDs share the SCCP frame header with station traffic, but they are not legal inputs to ClientMessage or outputs from ServerMessage.

Variants§

§

MediaResourceNotification(MediaResourceNotification)

§

PortResponse(PortEndpoint)

§

StartSessionTransmission(SessionTransmission)

§

StopSessionTransmission(SessionTransmission)

§

ClearConference

Fields

§conference_id: ConferenceId
§service_number: u32
§

CreateConferenceRequest(CreateConferenceRequest)

§

DeleteConferenceRequest

Fields

§conference_id: ConferenceId
§

ModifyConferenceRequest(ModifyConferenceRequest)

§

AddParticipantRequest(AddParticipantRequest)

§

DropParticipantRequest

Fields

§conference_id: ConferenceId
§call_reference: CallReference
§

AuditConferenceRequest

§

AuditParticipantRequest

Fields

§conference_id: ConferenceId
§

ChangeParticipantRequest(ChangeParticipantRequest)

§

CreateConferenceResponse(CreateConferenceResponse)

§

DeleteConferenceResponse

Fields

§conference_id: ConferenceId
§

ModifyConferenceResponse(ModifyConferenceResponse)

§

AddParticipantResponse(AddParticipantResponse)

§

AuditConferenceResponse(AuditConferenceResponse)

§

AuditParticipantResponse(AuditParticipantResponse)

§

StartAnnouncement

Plays a bounded sequence of locale-aware tones for conference parties.

Fields

§announcements: Vec<AnnouncementEntry>
§end_of_ack: EndOfAnnouncementAck

Whether completion requires a protocol acknowledgement.

§conference_id: u32
§matrix_conference_party_ids: Vec<u32>

Party identifiers participating in the announcement matrix.

§hearing_conference_party_mask: u32

Bit mask selecting which matrix parties hear the announcement.

§

StopAnnouncement

Fields

§conference_id: u32
§

AnnouncementFinish

Fields

§conference_id: u32
§

QosReservationNotify

Fields

§flow: QosFlow
§direction: QosDirection
§

QosErrorNotify

Reports admission or reservation failure details for a media flow.

Fields

§flow: QosFlow
§direction: QosDirection
§error_code: QosErrorCode
§failure_node: Ipv4Addr

Network node that originated the RSVP error.

§rsvp_error_code: RsvpErrorCode
§rsvp_error_subcode: u32
§rsvp_error_flags: u32
§

QosListen

Establishes an RSVP listener and its retry/admission policy.

Fields

§flow: QosFlow
§reservation_style: QosReservationStyle
§maximum_retries: u32
§retry_timer: u32
§confirmation_required: bool

Whether the service node must confirm successful reservation.

§preemption_priority: u32

Priority used when competing reservations may be preempted.

§defending_priority: u32

Priority used when defending this reservation from preemption.

§

QosPath

Establishes the sending side of an RSVP path.

Fields

§flow: QosFlow
§reservation_style: QosReservationStyle
§maximum_retries: u32
§retry_timer: u32
§preemption_priority: u32
§defending_priority: u32
§

QosTeardown

Tears down QoS state for one direction of a media flow.

Fields

§flow: QosFlow
§direction: QosDirection
§

UpdateDscp

Updates the six-bit DSCP value for a media flow.

Fields

§flow: QosFlow
§dscp: u8
§

QosModify

Changes traffic parameters on an existing QoS reservation.

§

MessageWaitingNotification(MessageWaitingNotification)

§

MessageWaitingResponse

Fields

§target_number: String
§

KnownOpaque(KnownOpaqueMessage)

A documented role whose payload layout is not independently stable.

Implementations§

Source§

impl ControlMessage

Source

pub fn decode( frame: Frame, protocol: ProtocolVersion, ) -> Result<Self, CodecError>

Decode a frame whose catalog route is between call-control or service roles. Station messages fail closed instead of being interpreted by a structurally similar conference or QoS layout.

Source

pub fn encode(&self, protocol: ProtocolVersion) -> Result<Vec<u8>, CodecError>

Encodes a message routed between control and service roles.

Station-routed variants are rejected rather than emitted through the control-message API.

Trait Implementations§

Source§

impl Clone for ControlMessage

Source§

fn clone(&self) -> ControlMessage

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ControlMessage

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for ControlMessage

Source§

impl PartialEq for ControlMessage

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ControlMessage

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more