Skip to main content

EslEventType

Enum EslEventType 

Source
#[non_exhaustive]
pub enum EslEventType {
Show 94 variants Custom, Clone, ChannelCreate, ChannelDestroy, ChannelState, ChannelCallstate, ChannelAnswer, ChannelHangup, ChannelHangupComplete, ChannelExecute, ChannelExecuteComplete, ChannelHold, ChannelUnhold, ChannelBridge, ChannelUnbridge, ChannelProgress, ChannelProgressMedia, ChannelOutgoing, ChannelPark, ChannelUnpark, ChannelApplication, ChannelOriginate, ChannelUuid, Api, Log, InboundChan, OutboundChan, Startup, Shutdown, Publish, Unpublish, Talk, Notalk, SessionCrash, ModuleLoad, ModuleUnload, Dtmf, Message, PresenceIn, NotifyIn, PresenceOut, PresenceProbe, MessageWaiting, MessageQuery, Roster, Codec, BackgroundJob, DetectedSpeech, DetectedTone, PrivateCommand, Heartbeat, Trap, AddSchedule, DelSchedule, ExeSchedule, ReSchedule, ReloadXml, Notify, PhoneFeature, PhoneFeatureSubscribe, SendMessage, RecvMessage, RequestParams, ChannelData, General, Command, SessionHeartbeat, ClientDisconnected, ServerDisconnected, SendInfo, RecvInfo, RecvRtcpMessage, SendRtcpMessage, CallSecure, Nat, RecordStart, RecordStop, PlaybackStart, PlaybackStop, CallUpdate, Failure, SocketData, MediaBugStart, MediaBugStop, ConferenceDataQuery, ConferenceData, CallSetupReq, CallSetupResult, CallDetail, DeviceState, Text, ShutdownRequested, All, StartRecording,
}
Expand description

FreeSWITCH event types matching the canonical order from esl_event.h and switch_event.c EVENT_NAMES[].

Variant names are the canonical wire names (e.g. ChannelCreate = CHANNEL_CREATE).

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Custom

§

Clone

§

ChannelCreate

§

ChannelDestroy

§

ChannelState

§

ChannelCallstate

§

ChannelAnswer

§

ChannelHangup

§

ChannelHangupComplete

§

ChannelExecute

§

ChannelExecuteComplete

§

ChannelHold

§

ChannelUnhold

§

ChannelBridge

§

ChannelUnbridge

§

ChannelProgress

§

ChannelProgressMedia

§

ChannelOutgoing

§

ChannelPark

§

ChannelUnpark

§

ChannelApplication

§

ChannelOriginate

§

ChannelUuid

§

Api

§

Log

§

InboundChan

§

OutboundChan

§

Startup

§

Shutdown

§

Publish

§

Unpublish

§

Talk

§

Notalk

§

SessionCrash

§

ModuleLoad

§

ModuleUnload

§

Dtmf

§

Message

§

PresenceIn

§

NotifyIn

§

PresenceOut

§

PresenceProbe

§

MessageWaiting

§

MessageQuery

§

Roster

§

Codec

§

BackgroundJob

§

DetectedSpeech

§

DetectedTone

§

PrivateCommand

§

Heartbeat

§

Trap

§

AddSchedule

§

DelSchedule

§

ExeSchedule

§

ReSchedule

§

ReloadXml

§

Notify

§

PhoneFeature

§

PhoneFeatureSubscribe

§

SendMessage

§

RecvMessage

§

RequestParams

§

ChannelData

§

General

§

Command

§

SessionHeartbeat

§

ClientDisconnected

§

ServerDisconnected

§

SendInfo

§

RecvInfo

§

RecvRtcpMessage

§

SendRtcpMessage

§

CallSecure

§

Nat

§

RecordStart

§

RecordStop

§

PlaybackStart

§

PlaybackStop

§

CallUpdate

§

Failure

§

SocketData

§

MediaBugStart

§

MediaBugStop

§

ConferenceDataQuery

§

ConferenceData

§

CallSetupReq

§

CallSetupResult

§

CallDetail

§

DeviceState

§

Text

§

ShutdownRequested

§

All

Subscribe to all events

§

StartRecording

Present in switch_event.c but not in libs/esl/ EVENT_NAMES[].

Implementations§

Source§

impl EslEventType

Source

pub const fn as_str(&self) -> &'static str

Returns the canonical wire name as a static string slice.

Source

pub fn parse_event_type(s: &str) -> Option<Self>

Parse event type from wire name (canonical case).

Source§

impl EslEventType

Source

pub const CHANNEL_EVENTS: &[EslEventType]

Every CHANNEL_* event type.

Covers the full channel lifecycle: creation, state changes, execution, bridging, hold, park, progress, originate, and destruction.

use freeswitch_types::EslEventType;
assert!(EslEventType::CHANNEL_EVENTS.contains(&EslEventType::ChannelCreate));
assert!(EslEventType::CHANNEL_EVENTS.contains(&EslEventType::ChannelHangupComplete));
Source

pub const IN_CALL_EVENTS: &[EslEventType]

In-call events: DTMF, VAD speech detection, media security, and call updates.

Events that fire during an established call, tied to RTP/media activity rather than signaling state transitions.

use freeswitch_types::EslEventType;
assert!(EslEventType::IN_CALL_EVENTS.contains(&EslEventType::Dtmf));
assert!(EslEventType::IN_CALL_EVENTS.contains(&EslEventType::Talk));
Source

pub const MEDIA_EVENTS: &[EslEventType]

Media-related events: playback, recording, media bugs, and detection.

Useful for IVR applications that need to track media operations without subscribing to the full channel lifecycle.

use freeswitch_types::EslEventType;
assert!(EslEventType::MEDIA_EVENTS.contains(&EslEventType::PlaybackStart));
assert!(EslEventType::MEDIA_EVENTS.contains(&EslEventType::DetectedSpeech));
Source

pub const PRESENCE_EVENTS: &[EslEventType]

Presence and messaging events.

For applications that track user presence (BLF, buddy lists) or message-waiting indicators (voicemail MWI).

use freeswitch_types::EslEventType;
assert!(EslEventType::PRESENCE_EVENTS.contains(&EslEventType::PresenceIn));
assert!(EslEventType::PRESENCE_EVENTS.contains(&EslEventType::MessageWaiting));
Source

pub const SYSTEM_EVENTS: &[EslEventType]

System lifecycle events.

Server startup/shutdown, heartbeats, module loading, and XML reloads. Useful for monitoring dashboards and operational tooling.

use freeswitch_types::EslEventType;
assert!(EslEventType::SYSTEM_EVENTS.contains(&EslEventType::Heartbeat));
assert!(EslEventType::SYSTEM_EVENTS.contains(&EslEventType::Shutdown));
Source

pub const CONFERENCE_EVENTS: &[EslEventType]

Conference-related events.

use freeswitch_types::EslEventType;
assert!(EslEventType::CONFERENCE_EVENTS.contains(&EslEventType::ConferenceData));

Trait Implementations§

Source§

impl Clone for EslEventType

Source§

fn clone(&self) -> EslEventType

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for EslEventType

Source§

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

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

impl<'de> Deserialize<'de> for EslEventType

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for EslEventType

Source§

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

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

impl FromStr for EslEventType

Source§

type Err = ParseEventTypeError

The associated error which can be returned from parsing.
Source§

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type. Read more
Source§

impl Hash for EslEventType

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for EslEventType

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for EslEventType

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Copy for EslEventType

Source§

impl Eq for EslEventType

Source§

impl StructuralPartialEq for EslEventType

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,