Skip to main content

DeviceEventKind

sccp_protocol::server

Enum DeviceEventKind 

Source 
pub enum DeviceEventKind {

Show 41 variants    Registered(DeviceRegistration),
    Disconnected {},
    Capabilities {
        capabilities: StationMediaCapabilities,
    },
    OffHook {
        call_id: CallId,
        line_instance: LineInstance,
    },
    OnHook {
        call_id: CallId,
        line_instance: LineInstance,
    },
    Digit {
        call_id: CallId,
        digit: Digit,
    },
    EnblocCall {
        call_id: CallId,
        line_instance: LineInstance,
        number: String,
    },
    SoftKey {
        call_id: Option<CallId>,
        line_instance: LineInstance,
        soft_key: SoftKey,
    },
    LineButton {
        line_instance: LineInstance,
        call_id: Option<CallId>,
    },
    HookFlash {
        call_id: Option<CallId>,
        line_instance: LineInstance,
    },
    FeatureButton {
        instance: LineInstance,
    },
    DoNotDisturbButton {
        instance: LineInstance,
    },
    MobilityButton {
        instance: LineInstance,
    },
    VoicemailButton {
        call_id: CallId,
        line_instance: LineInstance,
    },
    ParkingLotButton {
        instance: LineInstance,
        call_id: Option<CallId>,
        line_instance: LineInstance,
    },
    ParkingMenuSelection {
        lot: String,
        slot: u32,
    },
    PhoneServiceResponse {
        response: PhoneServiceEvent,
    },
    ConferenceListAction {
        action: ConferenceListAction,
    },
    ReceiveChannelOpened {
        call_id: CallId,
        status: MediaStatus,
        endpoint: MediaEndpoint,
    },
    MultimediaReceiveChannelOpened {
        call_id: CallId,
        codec: Codec,
        endpoint: MediaEndpointAddress,
        passthrough_party_id: PassthroughPartyId,
    },
    MultimediaReceiveChannelFailed {
        call_id: CallId,
        codec: Codec,
        status: MediaStatus,
        endpoint: MediaEndpointAddress,
        passthrough_party_id: PassthroughPartyId,
    },
    MultimediaReceiveChannelTimedOut {
        call_id: CallId,
        codec: Codec,
        passthrough_party_id: PassthroughPartyId,
    },
    MultimediaTransmitStarted {
        call_id: CallId,
        codec: Codec,
        endpoint: MediaEndpointAddress,
        passthrough_party_id: PassthroughPartyId,
    },
    MultimediaTransmitFailed {
        call_id: CallId,
        codec: Codec,
        status: MediaStatus,
        endpoint: MediaEndpointAddress,
        passthrough_party_id: PassthroughPartyId,
    },
    MultimediaTransmitTimedOut {
        call_id: CallId,
        codec: Codec,
        passthrough_party_id: PassthroughPartyId,
    },
    TransmitChannelImplied {
        call_id: CallId,
        endpoint: MediaEndpoint,
    },
    TransmitChannelStarted {
        call_id: CallId,
        status: MediaStatus,
        endpoint: MediaEndpoint,
    },
    HandsetAcknowledgementTimedOut {
        call_id: CallId,
        acknowledgement: HandsetAcknowledgement,
    },
    MediaTransmissionFailed {
        call_id: CallId,
        status: MediaStatus,
        endpoint: MediaEndpoint,
    },
    MulticastReceptionStarted {
        conference_id: ConferenceId,
        call_id: CallId,
        route: MulticastMediaRoute,
    },
    MulticastReceptionFailed {
        conference_id: ConferenceId,
        call_id: CallId,
        status: MediaStatus,
    },
    MulticastReceptionTimedOut {
        conference_id: ConferenceId,
        call_id: CallId,
    },
    MulticastTransmissionStarted {
        conference_id: ConferenceId,
        call_id: CallId,
        route: MulticastMediaRoute,
    },
    MulticastTransmissionFailed {
        conference_id: ConferenceId,
        call_id: CallId,
        status: MediaStatus,
        address: IpAddr,
        port: u16,
    },
    ConnectionStatisticsCollected {
        snapshot: MediaStatisticsSnapshot,
    },
    Alarm {
        severity: AlarmSeverity,
        text: String,
        parameters: Option<[u32; 2]>,
    },
    XmlAlarm {
        telemetry: PhoneAlarmTelemetry,
    },
    LocationInformation {
        telemetry: PhoneLocationTelemetry,
    },
    HeadsetStatusChanged {
        enabled: bool,
    },
    MediaPathChanged {
        path: MediaPathId,
        event: MediaPathEvent,
    },
    UnhandledMessage {
        message: ClientMessage,
    },

}
Expand description

State transitions and handset input produced by one station session.

Call-bearing variants use the server-owned CallId rather than the raw wire reference. Media success and failure variants are emitted only after correlation against the current request generation.

Variants§

§

Registered(DeviceRegistration)

§

Disconnected

§

Capabilities

Fields

§capabilities: StationMediaCapabilities
§

OffHook

Fields

§call_id: CallId
§line_instance: LineInstance
§

OnHook

Fields

§call_id: CallId
§line_instance: LineInstance
§

Digit

Fields

§call_id: CallId
§digit: Digit
§

EnblocCall

Fields

§call_id: CallId
§line_instance: LineInstance
§number: String
§

SoftKey

Fields

§call_id: Option<CallId>

Active call when the key is call-scoped.

§line_instance: LineInstance
§soft_key: SoftKey
§

LineButton

Fields

§line_instance: LineInstance
§call_id: Option<CallId>
§

HookFlash

Fields

§call_id: Option<CallId>
§line_instance: LineInstance
§

FeatureButton

Fields

§instance: LineInstance
§

DoNotDisturbButton

Fields

§instance: LineInstance
§

MobilityButton

Fields

§instance: LineInstance
§

VoicemailButton

Press of a configured voicemail button, resolved to an exact line and addressable handset call before application dispatch.

Fields

§call_id: CallId
§line_instance: LineInstance
§

ParkingLotButton

Fields

§instance: LineInstance

Feature-button instance, distinct from the call line instance.

§call_id: Option<CallId>

Active call associated with the press, when any.

§line_instance: LineInstance
§

ParkingMenuSelection

Fields

§lot: String
§slot: u32
§

PhoneServiceResponse

Fields

§response: PhoneServiceEvent
§

ConferenceListAction

§

ReceiveChannelOpened

The receive-channel acknowledgement matched the current request.

Fields

§call_id: CallId
§status: MediaStatus
§endpoint: MediaEndpoint
§

MultimediaReceiveChannelOpened

Fields

§call_id: CallId
§codec: Codec
§endpoint: MediaEndpointAddress
§passthrough_party_id: PassthroughPartyId
§

MultimediaReceiveChannelFailed

Fields

§call_id: CallId
§codec: Codec
§status: MediaStatus
§endpoint: MediaEndpointAddress
§passthrough_party_id: PassthroughPartyId
§

MultimediaReceiveChannelTimedOut

Fields

§call_id: CallId
§codec: Codec
§passthrough_party_id: PassthroughPartyId
§

MultimediaTransmitStarted

Fields

§call_id: CallId
§codec: Codec
§endpoint: MediaEndpointAddress
§passthrough_party_id: PassthroughPartyId
§

MultimediaTransmitFailed

Fields

§call_id: CallId
§codec: Codec
§status: MediaStatus
§endpoint: MediaEndpointAddress
§passthrough_party_id: PassthroughPartyId
§

MultimediaTransmitTimedOut

Fields

§call_id: CallId
§codec: Codec
§passthrough_party_id: PassthroughPartyId
§

TransmitChannelImplied

The transmit half of a coupled outbound media transaction became open when the station acknowledged the matching receive request.

The adjacent StartMediaTransmission request may omit its separate acknowledgement. This event is deliberately distinct from DeviceEventKind::TransmitChannelStarted: callers can preserve the acknowledgement relationship while settling both halves of the one coupled transaction exactly once.

Fields

§call_id: CallId
§endpoint: MediaEndpoint
§

TransmitChannelStarted

The transmit-channel acknowledgement matched the current request.

Fields

§call_id: CallId
§status: MediaStatus
§endpoint: MediaEndpoint
§

HandsetAcknowledgementTimedOut

Fields

§call_id: CallId
§acknowledgement: HandsetAcknowledgement
§

MediaTransmissionFailed

Fields

§call_id: CallId
§status: MediaStatus
§endpoint: MediaEndpoint
§

MulticastReceptionStarted

Fields

§conference_id: ConferenceId
§call_id: CallId
§route: MulticastMediaRoute
§

MulticastReceptionFailed

Fields

§conference_id: ConferenceId
§call_id: CallId
§status: MediaStatus
§

MulticastReceptionTimedOut

Fields

§conference_id: ConferenceId
§call_id: CallId
§

MulticastTransmissionStarted

Fields

§conference_id: ConferenceId
§call_id: CallId
§route: MulticastMediaRoute
§

MulticastTransmissionFailed

Fields

§conference_id: ConferenceId
§call_id: CallId
§status: MediaStatus
§address: IpAddr
§port: u16
§

ConnectionStatisticsCollected

A requested statistics response was correlated and retained.

§

Alarm

Fields

§severity: AlarmSeverity
§text: String
§parameters: Option<[u32; 2]>
§

XmlAlarm

Fields

§telemetry: PhoneAlarmTelemetry
§

LocationInformation

Fields

§telemetry: PhoneLocationTelemetry
§

HeadsetStatusChanged

Fields

§enabled: bool
§

MediaPathChanged

§

UnhandledMessage

A well-framed client message has no server-side behavior yet.

Fields

§message: ClientMessage

Trait Implementations§

Source§

impl Clone for DeviceEventKind

Source§

fn clone(&self) -> DeviceEventKind

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 DeviceEventKind

Source§

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

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

impl Eq for DeviceEventKind

Source§

impl PartialEq for DeviceEventKind

Source§

fn eq(&self, other: &DeviceEventKind) -> 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 DeviceEventKind

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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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