Module message 

Typed SCCP messages used by the server.

This module also exposes wire values, framing, and contract metadata.

A typical inbound flow feeds TCP bytes to wire::FrameDecoder, validates the negotiated values::ProtocolVersion, then decodes the frame as ClientMessage, ServerMessage, or ControlMessage according to its catalog::MessageRoute. Outbound typed messages expose encode methods implemented by the private codec module. Unknown identifiers and partially modeled fields have explicit bounded-preservation types rather than being silently discarded.

Modules

capabilities

Structured station capability updates.

catalog

SCCP/SPCP message identifiers and direction metadata for the message domain.

values

Typed numeric values used by SCCP messages.

wire

SCCP frame encoding and incremental stream decoding.

Structs

AddParticipantRequest

Request to attach a call participant to a conference.

AddParticipantResponse

Result of adding a participant, including the service-assigned identity.

AnnouncementEntry

One locale-aware tone in a station announcement sequence.

AudioStreamControl

Identity fields shared by audio receive-close and transmit-stop commands.

AuditConferenceEntry

One conference record returned by an audit operation.

AuditConferenceResponse

A page of conference audit records.

AuditParticipantResponse

Participant audit entry bytes have an opaque schema. The typed envelope preserves them losslessly while enforcing the aggregate wire bound.

BoundedBytes

Owned wire bytes whose allocation is capped by the message contract.

BoundedBytesError

Failure returned when a value exceeds a BoundedBytes allocation limit.

ButtonTemplateEntry

One physical position in a station button template.

ChangeParticipantRequest

Update the presentation identity of an existing conference participant.

ConferenceParticipant

Presentation identity and call reference for a conference participant.

ConferenceParticipantChange

A participant-identity change independent of application-envelope routing.

ConfigurationStatus

Static station and user information returned by a configuration request.

ConnectionQualityStatistics

Bounded, owned station quality data retained for the typed MED-019 parser.

ConnectionStatistics

Packet, octet, timing, and station-provided quality statistics for a call.

CreateConferenceRequest

Parameters and application data for creating a station-managed conference.

CreateConferenceResponse

Result and returned application bytes for conference creation.

DtmfPayloadIdentity

Identity returned by a DTMF payload subscribe/unsubscribe operation.

DtmfPayloadRequest

Request to subscribe or unsubscribe a DTMF RTP payload mapping.

DtmfToneControl

One signaling DTMF tone associated with a conference media party.

ExtensionDeviceCapabilities

All three integers and the text buffer have unknown semantics, so the typed model preserves each value without assigning invented meaning.

KnownOpaqueMessage

A cataloged but untyped message retained for explicit bounded forwarding.

MediaCapability

One audio codec capability advertised by a station.

MediaEncryption

SRTP keying material. Debug output intentionally exposes metadata only.

MediaEndpointAddress

Network address and transport port for a media endpoint.

MediaFailureDetection

Audio media-failure detector configuration.

MediaRequestIdentity

Pending identity used to decide whether a handset media ACK belongs to the currently opening receive/transmit request.

MediaRequestToken

Non-zero token placed in the SCCP pass-through-party field to identify one media request generation, rather than the lifetime of a call.

MediaResourceNotification

Media-resource service capacity notification.

MediaTransmissionAck

Station acknowledgement for an audio media-transmission request.

MediaTransmissionAckWire

Optional eight-byte extension retained from a media-transmission ACK.

MessageWaitingCounts

New and previously heard message counts for one mailbox category.

MessageWaitingNotification

Message-waiting state and category counts for one target number.

MiscellaneousCommand

Codec-specific multimedia command and its bounded parameter block.

ModifyConferenceRequest

Parameters and application data for resizing or updating a conference.

ModifyConferenceResponse

Result and returned application bytes for conference modification.

MulticastMediaReception

Parameters for receiving an audio stream from a multicast endpoint.

MulticastMediaTransmission

Parameters for transmitting an audio stream to a multicast endpoint.

MultimediaCapabilityError

Failure returned when a video capability exceeds a fixed table bound.

MultimediaPayload

RTP descriptor and codec-selected capability for a multimedia stream.

MultimediaPayloadDescriptor

Two-word multimedia RTP descriptor.

MultimediaPictureFormat

One supported picture format and its minimum picture interval.

MultimediaStreamControl

Identity fields shared by multimedia close and stop commands.

MultimediaVideoCapability

Fully modeled video arm of a multimedia channel command.

OpenMultimediaChannel

Request to open a station multimedia receive channel.

OpenMultimediaReceiveChannelAck

Station acknowledgement for an opened multimedia receive channel.

OpenReceiveChannelWire

Fields in OpenReceiveChannel which are not part of the runtime media abstraction but are required for byte-exact capture round trips.

ParticipantChangeRouting

Routing metadata for a participant change carried by the V1 application envelope rather than a standalone station message identifier.

PortClose

Request to release a previously allocated media endpoint.

PortEndpoint

Allocated RTP/RTCP endpoint returned for a media flow.

PortRequest

Request to allocate an endpoint for one media flow.

QosApplicationIdentifier

Fixed application identity carried by QoS listen/path/modify requests.

QosFlow

Addressed media flow used by the intra-control QoS message family.

QosTrafficSpecification

RSVP traffic parameters.

RawMessage

An unrecognized frame retained without interpreting its identifier or payload.

RegisterTokenMessage

Station token-registration identity and network endpoint.

RegistrationMessage

Station registration identity, addressing, capacity, and feature data.

RegistrationWireDetails

Auxiliary fields carried by the extended station registration layout.

RtpPayloadNumber

Seven-bit RTP payload number used by a multimedia stream.

RtpPayloadNumberError

Failure returned when a value is outside the RTP payload-number range.

SessionTransmission

Remote address and type for starting or stopping a control session.

SignalingServerEndpoint

One reachable control endpoint in a station server-list response.

StartMediaTransmissionWire

Fields in StartMediaTransmission which are deliberately kept separate from the runtime RTP endpoint but must not be discarded by the codec.

StartMultimediaTransmission

Request to transmit a multimedia stream to a remote endpoint.

StartMultimediaTransmissionAck

Station acknowledgement for a multimedia transmit request.

SubscriptionRequest

Request to create or renew a feature subscription.

UserDataMessage

Original application-data envelope with routing identifiers and opaque data.

UserDataV1Message

The extended XML/application-data envelope introduced after SCCP v3.

VideoFlowControl

Maximum-bit-rate update for one video stream.

XmlAlarmMessage

Bounded XML alarm with exact inbound wire-payload preservation.

Enums

ClientMessage

Typed messages accepted from a station connection.

ControlMessage

Messages exchanged with conference/media-resource/call-control peers.

KeypadButtonWireLayout

Non-canonical phone-originated keypad bodies selected by their exact body length. None on ClientMessage::KeypadButton emits the current extended layout.

MultimediaVideoCapabilityArm

Codec-selected arm of a multimedia video capability.

ServerMessage

Typed messages emitted toward a station connection.

Constants

CONNECTION_QUALITY_MAX_BYTES

Maximum retained station quality-statistics payload.

MAX_MULTIMEDIA_PICTURE_FORMATS

Maximum picture-format entries in one multimedia video capability.

MAX_OPAQUE_MESSAGE_BYTES

Largest opaque body retained from a valid frame.

MAX_SIGNALING_SERVERS

Maximum endpoints carried by one station server-list response.

MULTIMEDIA_CAPABILITY_BYTES

Width of the codec-specific capability union in multimedia channel messages.

XML_ALARM_CANONICAL_DOCUMENT_BYTES

Maximum XML document size accepted by XmlAlarmMessage::from_xml.

XML_ALARM_CANONICAL_WIRE_BYTES

Deterministic payload size emitted by XmlAlarmMessage::from_xml.

XML_ALARM_MAX_WIRE_BYTES

Maximum inbound XML-alarm payload retained by the decoder.