Skip to main content

TransactionState

Enum TransactionState 

Source
#[non_exhaustive]
pub enum TransactionState { Nothing, Calling, Trying, Proceeding, Accepted, Completed, Confirmed, Terminated, }
Expand description

SIP Transaction State

TransactionState represents the various states a SIP transaction can be in during its lifecycle. These states implement the transaction state machines defined in RFC 3261 for both client and server transactions, with the RFC 6026 Accepted state for INVITE 2xx response handling.

§States

  • Nothing - Initial state for client transactions created
  • Calling - Initial state for client transactions when request is sent or received
  • Trying - Request has been sent/received, waiting for response/processing
  • Proceeding - Provisional response received/sent (1xx except 100 Trying)
  • Accepted - INVITE transaction received/sent a 2xx final response (RFC 6026 §7.1/§7.2); server transaction waits for ACKs and absorbs 2xx retransmissions from the TU until Timer L fires; client transaction absorbs 2xx retransmissions from the server until Timer M fires.
  • Completed - Final non-2xx response received/sent (RFC 3261 §17), waiting for ACK (server INVITE) or response retransmissions (client). For INVITE 2xx, see Accepted (RFC 6026 supersedes RFC 3261 §17.2.1 paragraph 4 / §17.1.1.2).
  • Confirmed - ACK received/sent for INVITE non-2xx (3xx-6xx) transactions
  • Terminated - Transaction has completed and is being cleaned up

§State Transitions

§Client Non-INVITE Transaction (RFC 3261 §17.1.2)

Nothing → Calling → Trying → Proceeding → Completed → Terminated

§Client INVITE Transaction (RFC 3261 §17.1.1 + RFC 6026 §7.2)

Nothing → Calling → Trying → Proceeding ──2xx──→ Accepted ──Timer M──→ Terminated
                                      │
                                      └──3xx-6xx──→ Completed → Confirmed → Terminated

§Server INVITE Transaction (RFC 3261 §17.2.1 + RFC 6026 §7.1)

Calling → Trying → Proceeding ──2xx──→ Accepted ──Timer L──→ Terminated
                             │
                             └──3xx-6xx──→ Completed ──ACK──→ Confirmed → Terminated

§Server Non-INVITE Transaction (RFC 3261 §17.2.2)

Calling → Trying → Proceeding → Completed → Terminated

§Examples

use rsipstack::transaction::TransactionState;

let state = TransactionState::Proceeding;
match state {
    TransactionState::Nothing => println!("Transaction starting"),
    TransactionState::Calling => println!("Request sent"),
    TransactionState::Trying => println!("Request sent/received"),
    TransactionState::Proceeding => println!("Provisional response"),
    TransactionState::Accepted => println!("2xx accepted; waiting for Timer L/M"),
    TransactionState::Completed => println!("Final non-2xx response"),
    TransactionState::Confirmed => println!("ACK received/sent"),
    TransactionState::Terminated => println!("Transaction complete"),
    // `#[non_exhaustive]`: downstream code MUST keep a wildcard arm to
    // remain forward-compatible with future state additions.
    _ => println!("future RFC-extension state"),
}

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

Nothing

§

Calling

§

Trying

§

Proceeding

§

Accepted

RFC 6026 §7.1 (server) / §7.2 (client): an INVITE transaction has sent or received a 2xx final response. The server absorbs 2xx retransmissions from the TU and waits for ACK until Timer L (= 64T1) fires; the client absorbs server-retransmitted 2xx responses until Timer M (= 64T1) fires. Replaces the RFC 3261 §17.1.1.2 / §17.2.1 behaviour that incorrectly routed 2xx through the Completed state.

§

Completed

§

Confirmed

§

Terminated

Trait Implementations§

Source§

impl Clone for TransactionState

Source§

fn clone(&self) -> Self

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 TransactionState

Source§

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

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

impl Display for TransactionState

Source§

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

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

impl PartialEq for TransactionState

Source§

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

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = !

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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