Skip to main content

EventHeader

Enum EventHeader 

Source
#[non_exhaustive]
pub enum EventHeader {
Show 129 variants EventName, EventSubclass, UniqueId, CallerUniqueId, OtherLegUniqueId, ChannelCallUuid, JobUuid, ChannelName, ChannelState, ChannelStateNumber, ChannelCallState, AnswerState, CallDirection, HangupCause, CallerCallerIdName, CallerCallerIdNumber, CallerOrigCallerIdName, CallerOrigCallerIdNumber, CallerCalleeIdName, CallerCalleeIdNumber, CallerDestinationNumber, CallerContext, CallerDirection, CallerNetworkAddr, CoreUuid, DtmfDigit, Priority, LogLevel, PlData, SipEvent, SipContentType, GatewayName, ChannelReadCodecName, ChannelReadCodecRate, ChannelReadCodecBitRate, ChannelReportedReadCodecRate, ChannelWriteCodecName, ChannelWriteCodecRate, ChannelWriteCodecBitRate, ChannelReportedWriteCodecRate, ChannelVideoReadCodecName, ChannelVideoReadCodecRate, ChannelVideoWriteCodecName, ChannelVideoWriteCodecRate, SessionCount, FreeswitchHostname, FreeswitchSwitchname, FreeswitchIpv4, FreeswitchIpv6, FreeswitchVersion, FreeswitchDomain, FreeswitchUser, Application, ApplicationData, ApplicationResponse, ApplicationUuid, EventDateLocal, EventDateGmt, EventDateTimestamp, EventCallingFile, EventCallingFunction, EventCallingLineNumber, EventSequence, ChannelPresenceId, ChannelPresenceData, PresenceDataCols, PresenceCallDirection, ChannelHitDialplan, SessionExternalId, OtherType, ChannelCallStateNumber, OriginalChannelCallState, DtmfDuration, DtmfSource, CallerLogicalDirection, CallerUsername, CallerDialplan, CallerAni, CallerAniii, CallerSource, CallerTransferSource, CallerRdnis, CallerChannelName, CallerProfileIndex, CallerScreenBit, CallerPrivacyHideName, CallerPrivacyHideNumber, OtherLegDirection, OtherLegLogicalDirection, OtherLegUsername, OtherLegDialplan, OtherLegCallerIdName, OtherLegCallerIdNumber, OtherLegOrigCallerIdName, OtherLegOrigCallerIdNumber, OtherLegCalleeIdName, OtherLegCalleeIdNumber, OtherLegNetworkAddr, OtherLegAni, OtherLegAniii, OtherLegDestinationNumber, OtherLegSource, OtherLegTransferSource, OtherLegContext, OtherLegRdnis, OtherLegChannelName, OtherLegProfileIndex, OtherLegScreenBit, OtherLegPrivacyHideName, OtherLegPrivacyHideNumber, UpTime, UptimeMsec, MaxSessions, SessionPeakMax, SessionPeakFiveMin, SessionPerSec, SessionPerSecFiveMin, SessionPerSecMax, SessionPerSecLast, SessionSinceStartup, IdleCpu, HeartbeatInterval, EventInfo, LogData, LogFile, LogFunction, LogLine, UserData, ApplicationUuidName,
}
Expand description

Top-level header names that appear in FreeSWITCH ESL events.

These are the headers on the parsed event itself (not protocol framing headers like Content-Type). Use with EslEvent::header() for type-safe lookups.

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.
§

EventName

§

EventSubclass

§

UniqueId

§

CallerUniqueId

§

OtherLegUniqueId

§

ChannelCallUuid

§

JobUuid

§

ChannelName

§

ChannelState

§

ChannelStateNumber

§

ChannelCallState

§

AnswerState

§

CallDirection

§

HangupCause

§

CallerCallerIdName

§

CallerCallerIdNumber

§

CallerOrigCallerIdName

§

CallerOrigCallerIdNumber

§

CallerCalleeIdName

§

CallerCalleeIdNumber

§

CallerDestinationNumber

§

CallerContext

§

CallerDirection

§

CallerNetworkAddr

§

CoreUuid

§

DtmfDigit

§

Priority

§

LogLevel

§

PlData

SIP NOTIFY body content (JSON payload from NOTIFY_IN events).

§

SipEvent

SIP event package name from NOTIFY_IN events (e.g. emergency-AbandonedCall).

§

SipContentType

SIP content type from NOTIFY_IN events.

§

GatewayName

Gateway that received the SIP NOTIFY.

§

ChannelReadCodecName

§

ChannelReadCodecRate

§

ChannelReadCodecBitRate

§

ChannelReportedReadCodecRate

Only present when actual_samples_per_second != samples_per_second.

§

ChannelWriteCodecName

§

ChannelWriteCodecRate

§

ChannelWriteCodecBitRate

§

ChannelReportedWriteCodecRate

Only present when actual_samples_per_second != samples_per_second.

§

ChannelVideoReadCodecName

§

ChannelVideoReadCodecRate

§

ChannelVideoWriteCodecName

§

ChannelVideoWriteCodecRate

§

SessionCount

Active session count from HEARTBEAT events.

§

FreeswitchHostname

§

FreeswitchSwitchname

§

FreeswitchIpv4

§

FreeswitchIpv6

§

FreeswitchVersion

§

FreeswitchDomain

§

FreeswitchUser

§

Application

§

ApplicationData

§

ApplicationResponse

§

ApplicationUuid

§

EventDateLocal

§

EventDateGmt

§

EventDateTimestamp

§

EventCallingFile

§

EventCallingFunction

§

EventCallingLineNumber

§

EventSequence

§

ChannelPresenceId

§

ChannelPresenceData

§

PresenceDataCols

§

PresenceCallDirection

§

ChannelHitDialplan

§

SessionExternalId

§

OtherType

originator or originatee on bridged channel events.

§

ChannelCallStateNumber

§

OriginalChannelCallState

§

DtmfDuration

§

DtmfSource

§

CallerLogicalDirection

§

CallerUsername

§

CallerDialplan

§

CallerAni

§

CallerAniii

§

CallerSource

§

CallerTransferSource

§

CallerRdnis

§

CallerChannelName

§

CallerProfileIndex

§

CallerScreenBit

§

CallerPrivacyHideName

§

CallerPrivacyHideNumber

§

OtherLegDirection

§

OtherLegLogicalDirection

§

OtherLegUsername

§

OtherLegDialplan

§

OtherLegCallerIdName

§

OtherLegCallerIdNumber

§

OtherLegOrigCallerIdName

§

OtherLegOrigCallerIdNumber

§

OtherLegCalleeIdName

§

OtherLegCalleeIdNumber

§

OtherLegNetworkAddr

§

OtherLegAni

§

OtherLegAniii

§

OtherLegDestinationNumber

§

OtherLegSource

§

OtherLegTransferSource

§

OtherLegContext

§

OtherLegRdnis

§

OtherLegChannelName

§

OtherLegProfileIndex

§

OtherLegScreenBit

§

OtherLegPrivacyHideName

§

OtherLegPrivacyHideNumber

§

UpTime

Seconds since FreeSWITCH startup.

§

UptimeMsec

Milliseconds since FreeSWITCH startup.

§

MaxSessions

§

SessionPeakMax

§

SessionPeakFiveMin

§

SessionPerSec

§

SessionPerSecFiveMin

§

SessionPerSecMax

§

SessionPerSecLast

§

SessionSinceStartup

§

IdleCpu

§

HeartbeatInterval

§

EventInfo

§

LogData

§

LogFile

§

LogFunction

§

LogLine

§

UserData

§

ApplicationUuidName

Implementations§

Source§

impl EventHeader

Source

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

Canonical protocol string.

Trait Implementations§

Source§

impl AsRef<str> for EventHeader

Source§

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl Clone for EventHeader

Source§

fn clone(&self) -> EventHeader

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 EventHeader

Source§

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

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

impl<'de> Deserialize<'de> for EventHeader

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 EventHeader

Source§

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

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

impl FromStr for EventHeader

Source§

type Err = ParseEventHeaderError

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 EventHeader

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 EventHeader

Source§

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

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 EventHeader

Source§

impl Eq for EventHeader

Source§

impl StructuralPartialEq for EventHeader

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>,