Expand description
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§
- AddParticipant
Request - Request to attach a call participant to a conference.
- AddParticipant
Response - Result of adding a participant, including the service-assigned identity.
- Announcement
Entry - One locale-aware tone in a station announcement sequence.
- Audio
Stream Control - Identity fields shared by audio receive-close and transmit-stop commands.
- Audit
Conference Entry - One conference record returned by an audit operation.
- Audit
Conference Response - A page of conference audit records.
- Audit
Participant Response - Participant audit entry bytes have an opaque schema. The typed envelope preserves them losslessly while enforcing the aggregate wire bound.
- Bounded
Bytes - Owned wire bytes whose allocation is capped by the message contract.
- Bounded
Bytes Error - Failure returned when a value exceeds a
BoundedBytesallocation limit. - Button
Template Entry - One physical position in a station button template.
- Change
Participant Request - Update the presentation identity of an existing conference participant.
- Conference
Participant - Presentation identity and call reference for a conference participant.
- Conference
Participant Change - A participant-identity change independent of application-envelope routing.
- Configuration
Status - Static station and user information returned by a configuration request.
- Connection
Quality Statistics - Bounded, owned station quality data retained for the typed MED-019 parser.
- Connection
Statistics - Packet, octet, timing, and station-provided quality statistics for a call.
- Create
Conference Request - Parameters and application data for creating a station-managed conference.
- Create
Conference Response - Result and returned application bytes for conference creation.
- Dtmf
Payload Identity - Identity returned by a DTMF payload subscribe/unsubscribe operation.
- Dtmf
Payload Request - Request to subscribe or unsubscribe a DTMF RTP payload mapping.
- Dtmf
Tone Control - One signaling DTMF tone associated with a conference media party.
- Extension
Device Capabilities - All three integers and the text buffer have unknown semantics, so the typed model preserves each value without assigning invented meaning.
- Known
Opaque Message - A cataloged but untyped message retained for explicit bounded forwarding.
- Media
Capability - One audio codec capability advertised by a station.
- Media
Encryption - SRTP keying material. Debug output intentionally exposes metadata only.
- Media
Endpoint Address - Network address and transport port for a media endpoint.
- Media
Failure Detection - Audio media-failure detector configuration.
- Media
Port List - Media
Request Identity - Pending identity used to decide whether a handset media ACK belongs to the currently opening receive/transmit request.
- Media
Request Token - Non-zero token placed in the SCCP pass-through-party field to identify one media request generation, rather than the lifetime of a call.
- Media
Resource Notification - Media-resource service capacity notification.
- Media
Transmission Ack - Station acknowledgement for an audio media-transmission request.
- Media
Transmission AckWire - Optional eight-byte extension retained from a media-transmission ACK.
- Message
Waiting Counts - New and previously heard message counts for one mailbox category.
- Message
Waiting Notification - Message-waiting state and category counts for one target number.
- Miscellaneous
Command - Codec-specific multimedia command and its bounded parameter block.
- Modify
Conference Request - Parameters and application data for resizing or updating a conference.
- Modify
Conference Response - Result and returned application bytes for conference modification.
- Multicast
Media Reception - Parameters for receiving an audio stream from a multicast endpoint.
- Multicast
Media Transmission - Parameters for transmitting an audio stream to a multicast endpoint.
- Multimedia
Capability Error - Failure returned when a video capability exceeds a fixed table bound.
- Multimedia
Payload - RTP descriptor and codec-selected capability for a multimedia stream.
- Multimedia
Payload Descriptor - Two-word multimedia RTP descriptor.
- Multimedia
Picture Format - One supported picture format and its minimum picture interval.
- Multimedia
Stream Control - Identity fields shared by multimedia close and stop commands.
- Multimedia
Video Capability - Fully modeled video arm of a multimedia channel command.
- Open
Multimedia Channel - Request to open a station multimedia receive channel.
- Open
Multimedia Receive Channel Ack - Station acknowledgement for an opened multimedia receive channel.
- Open
Receive Channel Wire - Fields in OpenReceiveChannel which are not part of the runtime media abstraction but are required for byte-exact capture round trips.
- Participant
Change Routing - Routing metadata for a participant change carried by the V1 application envelope rather than a standalone station message identifier.
- Port
Close - Request to release a previously allocated media endpoint.
- Port
Endpoint - Allocated RTP/RTCP endpoint returned for a media flow.
- Port
Request - Request to allocate an endpoint for one media flow.
- QosApplication
Identifier - Fixed application identity carried by QoS listen/path/modify requests.
- QosFlow
- Addressed media flow used by the intra-control QoS message family.
- QosTraffic
Specification - RSVP traffic parameters.
- RawMessage
- An unrecognized frame retained without interpreting its identifier or payload.
- Register
Token Message - Station token-registration identity and network endpoint.
- Registration
Message - Station registration identity, addressing, capacity, and feature data.
- Registration
Wire Details - Auxiliary fields carried by the extended station registration layout.
- RtpPayload
Number - Seven-bit RTP payload number used by a multimedia stream.
- RtpPayload
Number Error - Failure returned when a value is outside the RTP payload-number range.
- Session
Transmission - Remote address and type for starting or stopping a control session.
- Signaling
Server Endpoint - One reachable control endpoint in a station server-list response.
- Spcp
Register Token Message - Start
Media Transmission Wire - Fields in StartMediaTransmission which are deliberately kept separate from the runtime RTP endpoint but must not be discarded by the codec.
- Start
Multimedia Transmission - Request to transmit a multimedia stream to a remote endpoint.
- Start
Multimedia Transmission Ack - Station acknowledgement for a multimedia transmit request.
- Subscription
Request - Request to create or renew a feature subscription.
- User
Data Message - Original application-data envelope with routing identifiers and opaque data.
- User
Data V1Message - The extended XML/application-data envelope introduced after SCCP v3.
- Video
Flow Control - Maximum-bit-rate update for one video stream.
- XmlAlarm
Message - Bounded XML alarm with exact inbound wire-payload preservation.
Enums§
- Client
Message - Typed messages accepted from a station connection.
- Control
Message - Messages exchanged with conference/media-resource/call-control peers.
- Keypad
Button Wire Layout - Non-canonical phone-originated keypad bodies selected by their exact body
length.
NoneonClientMessage::KeypadButtonemits the current extended layout. - Multimedia
Video Capability Arm - Codec-selected arm of a multimedia video capability.
- Server
Message - 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.
- MEDIA_
PORT_ LIST_ MAX_ PORTS - 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.