Enum SessionError 

pub enum SessionError {
    SessionNotFound(String),
    InvalidTransition(String),
    DialogError(String),
    MediaError(String),
    MediaIntegration {
        reason: String,
    },
    SDPNegotiationFailed(String),
    ConfigurationError(String),
    ConfigError(String),
    InvalidInput(String),
    Timeout(String),
    NetworkError(String),
    ProtocolError(String),
    UnreliableProvisionalsNotSupported,
    MissingCredentialsForInviteAuth,
    MissingCredentialsForRequestAuth {
        method: Method,
    },
    InviteAuthRetryExhausted,
    RequestAuthRetryExhausted {
        method: Method,
    },
    InternalError(String),
    IoError(Error),
    NotImplemented(String),
    TransferFailed(String),
    AuthError(String),
    RegistrationFailed(String),
    Other(String),
    HeaderPolicy {
        method: Method,
        header: HeaderName,
        reason: ViolationReason,
    },
    MissingRequiredHeader {
        method: Method,
        names: Vec<HeaderName>,
    },
    Conflict {
        method: Method,
    },
}

Errors returned by the rvoip-sip session layer.

Variants

SessionNotFound(String)

No session with the given identifier exists in the registry.

InvalidTransition(String)

A requested state-machine transition is not legal from the current state.

DialogError(String)

An error originating in the dialog layer (rvoip-sip-dialog).

MediaError(String)

An error originating in the media layer (rvoip-media-core).

MediaIntegration

SIP signalling succeeded but wiring media to the negotiated session failed.

Fields

reason: String

Human-readable description of the media-integration failure.

SDPNegotiationFailed(String)

SDP offer/answer negotiation failed (no common codec, malformed SDP, etc.).

ConfigurationError(String)

Invalid or inconsistent configuration supplied to a builder or coordinator.

ConfigError(String)

Configuration error (legacy alias of SessionError::ConfigurationError).

InvalidInput(String)

An application-supplied argument was malformed or out of range.

Timeout(String)

An operation did not complete within its allotted time.

NetworkError(String)

A transport-level network error occurred.

ProtocolError(String)

A SIP protocol violation was detected.

UnreliableProvisionalsNotSupported

RFC 3262 — the remote peer did not advertise Supported: 100rel on the INVITE, so we cannot send a reliable 183 Session Progress. Raised by send_early_media. Today we fail fast; a future send_progress(sdp) API could fall back to an unreliable 183.

MissingCredentialsForInviteAuth

RFC 3261 §22.2 — the server challenged our INVITE with 401/407 but the session has no credentials on file. Set credentials via StreamPeerBuilder::with_credentials (per-peer default) or control.invite(...).with_credentials(...) (per-call).

MissingCredentialsForRequestAuth

RFC 3261 §22.2 — the server challenged an outbound request with 401/407 but the request flow has no credentials on file.

Fields

method: Method

SIP method that was challenged.

InviteAuthRetryExhausted

RFC 3261 §22.2 — INVITE auth has already been retried once and the server challenged again. Prevents loops against a broken server or wrong credentials.

RequestAuthRetryExhausted

RFC 3261 §22.2 — outbound request auth has already been retried once and the server challenged again.

Fields

method: Method

SIP method whose auth retry limit was exceeded.

InternalError(String)

An unexpected internal invariant was violated.

IoError(Error)

An underlying std::io error (transport sockets, file I/O).

NotImplemented(String)

The requested capability is recognized but not yet implemented.

TransferFailed(String)

A call transfer (REFER flow) failed.

AuthError(String)

Authentication failed or could not be completed.

RegistrationFailed(String)

A REGISTER flow failed after any supported retry path.

Other(String)

A flattened/stringly error from a lower layer that has no dedicated variant.

HeaderPolicy

SIP_API_DESIGN_2 §8 — a builder setter or with_header call staged a header that violates the per-method policy. The most common case is staging a stack-managed name (Call-ID, CSeq, Via, Max-Forwards) or a method-shaped name that has a dedicated setter (e.g. Authorization -> with_credentials / with_auth).

Fields

method: Method

SIP method whose per-method header policy was violated.

header: HeaderName

The offending header name.

reason: ViolationReason

Why the header was rejected.

MissingRequiredHeader

SIP_API_DESIGN_2 §8 — HeaderPolicy::validate_outbound reported one or more required application-supplied headers were missing for the chosen method.

Fields

method: Method

SIP method that requires the missing header(s).

names: Vec<HeaderName>

The required header names that were not supplied.

Conflict

SIP_API_DESIGN_2 §7.3 invariant #5 — a second .send() was attempted on the same session for a method whose pending_<method>_options stash slot is still occupied by an in-flight prior .send(). Wait for the first future to complete (or drop cleanly) before starting another of the same method.

Fields

method: Method

SIP method whose in-flight .send() blocks a second concurrent send.

Implementations

impl SessionError

pub fn is_session_gone(&self) -> bool

True if this error means “the session is already gone from the registry” — covers both the typed SessionNotFound variant and the stringly-wrapped Other("Session not found: …") form that falls out of the From<Box<dyn Error>> flatteners above.

Useful for fire-and-forget teardown paths (e.g. SessionHandle::hangup) that race against a natural call-ended cleanup: if the race is lost, the goal is already achieved and the error should be silent.

Trait Implementations

impl Debug for SessionError

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

Formats the value using the given formatter.

impl Display for SessionError

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

Formats the value using the given formatter.

impl Error for SessionError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<AuthError> for SessionError

fn from(err: AuthError) -> Self

Converts to this type from the input type.

impl From<Box<dyn Error + Send + Sync>> for SessionError

fn from(err: Box<dyn Error + Send + Sync>) -> Self

Converts to this type from the input type.

impl From<Box<dyn Error>> for SessionError

fn from(err: Box<dyn Error>) -> Self

Converts to this type from the input type.

impl From<Error> for SessionError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<HeaderPolicyViolation> for SessionError

fn from(v: HeaderPolicyViolation) -> Self

Converts to this type from the input type.

impl From<SessionError> for B2buaError

fn from(source: SessionError) -> Self

Converts to this type from the input type.

impl From<SessionError> for TransferError

fn from(err: SessionError) -> Self

Converts to this type from the input type.