Architecture & Design¶
sip2json is engineered around zero-copy std::string_view parsing, stateless execution, 64-bit constexpr FNV-1a hash matching, and modern C++20 type safety.
Architectural Principles¶
- Stateless Operations: No connection state or dialog state machine logic.
- First-Class JSON: Serializes to and from
nlohmann::jsonobjects without transformation layers. - Iterator Stream Parsing: Processes non-owning string buffers directly, supporting non-blocking stream drains.
- Header-Only: Single
#include <siddiqsoft/, zero compiled dependencies, zero regex dependencies.sip2json.hpp>
Subsystem Topology¶
The system is organized into distinct architectural layers with strict separation of concerns:
1. Public API Layer¶
Provides high-level developer interfaces and message domain models:
siddiqsoft/: Primary facade providing static entry points:sip2json.hpp parse(std::string_view): Decodes single datagram frames.parseAsync(std::string_view&, onMsg, onErr): Continuous multi-frame stream scanner with callback dispatch and buffer progression.parseFromBuffer(std::string_view): Fast-path standalone buffer consumption.serialize(const sipmessage&): RFC 3261 compliance wire serializer.
siddiqsoft/: Primary message container extendingsipmessage.hpp nlohmann::json:/s: Start line (type,method,uri,version,statusCode,reason)./h: Canonical header map with compact alias lookup (Call-ID,From,To,Via,CSeq, etc.)./b: Message payload and parsed SDP structure./meta: Provenance metadata (version,time,ttx).
2. Parser & Serializer Engines (private/)¶
Internal high-throughput token scanners and wire formatters:
sip2json_parser.hpp: Linear-time non-backtracking scanner for start line, headers, and body boundary detection.sip2json_serializer.hpp: Canonical serializer formatting headers, parameters, and payloads into CRLF-separated byte streams.sip2json_sdp.hpp: RFC 4566 / RFC 8866 Session Description Protocol parser and JSON serializer.
3. Protocol Dictionaries & Token Tables (private/)¶
Precomputed mapping tables and constexpr hashing:
sip2json_header_keys.hpp: 64-bit constexpr FNV-1a hash dispatch (hash_header_key) with case-folding and compact-to-canonical aliases (i->Call-ID,m->Contact,c->Content-Type,l->Content-Length).sip2json_constants.hpp: SIP method literals (INVITE,ACK,BYE,CANCEL), version strings, delimiters (CRLF,SP,COLON), and JSON field pointers.sip2json_response_codes.hpp: Numeric status codes (100-699) and RFC 3261 reason phrases.
4. Diagnostics & Utilities (private/)¶
Core utilities and diagnostic classifications:
sip2json_exception.hpp: Exception typesiddiqsoft::sip2json_exception(derivesstd::runtime_error) and error classificationssiddiqsoft::sip2jsonErrors.sip2json_datetime.hpp: High-precision ISO 8601 UTC and RFC 1123 datetime generators for message metadata.sip2json_utils.hpp: Zero-copy string view trimming, pointer escaping, and delimiter scanner helpers.
5. External Dependencies¶
nlohmann::json: Header-only JSON library serving as the base class forsipmessage.std::runtime_error: Standard C++ exception base forsip2json_exception.- C++20 Standard Library:
std::string_view,std::functional,std::format,std::chrono.
Component Relationships & Data Flow¶
- Class Inheritance:
siddiqsoft::sipmessageinherits publicnlohmann::json.siddiqsoft::sip2json_exceptioninherits publicstd::runtime_error.
- Inclusion & Orchestration:
siddiqsoft/includessip2json.hpp sipmessage.hpp,sip2json_parser.hpp,sip2json_serializer.hpp, andsip2json_sdp.hpp.siddiqsoft::sip2jsonproduces and consumessiddiqsoft::sipmessage.
- Engine Delegation & Data Flow:
sip2json_parser.hppdelegates payload parsing tosip2json_sdp.hpp, usessip2json_header_keys.hppfor canonical hashing, usessip2json_utils.hppfor delimiter scanning, and throwssip2json_exceptionon framing errors.sip2json_serializer.hppdelegates SDP serialization tosip2json_sdp.hpp, referencessip2json_constants.hppfor delimiters, and formats wire buffers.sipmessage.hpputilizessip2json_header_keys.hpp,sip2json_constants.hpp,sip2json_response_codes.hpp, andsip2json_datetime.hppfor accessor helpers.
Subsystem Topology & Component Structure¶
flowchart TD
subgraph PublicAPI["Public API Layer (include/siddiqsoft/)"]
S2J["siddiqsoft::sip2json<br/><i>Static Parser & Serializer Facade</i>"]
SMSG["siddiqsoft::sipmessage<br/><i>SIP Message Container DTO</i>"]
end
subgraph InternalEngines["Parser & Serializer Engines (private/)"]
Parser["sip2json_parser<br/><i>Zero-Copy Token & Delimiter Scanner</i>"]
Serial["sip2json_serializer<br/><i>RFC 3261 Wire Serializer</i>"]
SDP["sip2json_sdp<br/><i>RFC 4566 / 8866 SDP Body Engine</i>"]
end
subgraph ProtocolDict["Dictionaries & Token Tables (private/)"]
HKS["sip2json_header_keys<br/><i>64-bit constexpr FNV-1a Dispatch</i>"]
Const["sip2json_constants<br/><i>Method Literals & Delimiters</i>"]
Resp["sip2json_response_codes<br/><i>Numeric Status Code Tables</i>"]
DT["sip2json_datetime<br/><i>ISO 8601 & RFC 1123 Generators</i>"]
end
subgraph Diagnostics["Diagnostics & Utilities (private/)"]
Exc["sip2json_exception<br/><i>Diagnostics & sip2jsonErrors</i>"]
Utils["sip2json_utils<br/><i>String View & Memory Utilities</i>"]
end
subgraph External["External Base DOM"]
JSON["nlohmann::json<br/><i>JSON Document Base Class</i>"]
StdErr["std::runtime_error<br/><i>C++ Standard Exception</i>"]
end
S2J -->|produces / consumes| SMSG
SMSG -->|inherits| JSON
Exc -->|inherits| StdErr
S2J -->|delegates streaming| Parser
S2J -->|delegates serialization| Serial
Parser -->|delegates body payload| SDP
Serial -->|formats payload| SDP
Parser -->|canonical lookup| HKS
Parser -->|scans delimiters| Utils
Parser -->|throws framing errors| Exc
SMSG -->|queries aliases| HKS
SMSG -->|references codes| Resp
SMSG -->|timestamps| DT
Serial -->|delimiters & tokens| Const
classDef apiLayer fill:rgba(35,73,109,0.08),stroke:#23496d,stroke-width:2px;
classDef engineLayer fill:rgba(15,118,110,0.08),stroke:#0f766e,stroke-width:2px;
classDef dictLayer fill:rgba(109,40,217,0.06),stroke:#6d28d9,stroke-width:1.5px;
classDef diagLayer fill:rgba(185,28,28,0.06),stroke:#b91c1c,stroke-width:1.5px;
classDef extLayer fill:rgba(100,116,139,0.06),stroke:#64748b,stroke-width:1.5px,stroke-dasharray: 4 3;
class S2J,SMSG apiLayer;
class Parser,Serial,SDP engineLayer;
class HKS,Const,Resp,DT dictLayer;
class Exc,Utils diagLayer;
class JSON,StdErr extLayer;
click S2J "https://github.com/SiddiqSoft/sip2json/blob/master/include/siddiqsoft/sip2json.hpp" "Source: sip2json.hpp"
click SMSG "https://github.com/SiddiqSoft/sip2json/blob/master/include/siddiqsoft/sipmessage.hpp" "Source: sipmessage.hpp"
click Parser "https://github.com/SiddiqSoft/sip2json/blob/master/include/siddiqsoft/private/sip2json_parser.hpp" "Source: sip2json_parser.hpp"
click Serial "https://github.com/SiddiqSoft/sip2json/blob/master/include/siddiqsoft/private/sip2json_serializer.hpp" "Source: sip2json_serializer.hpp"
click SDP "https://github.com/SiddiqSoft/sip2json/blob/master/include/siddiqsoft/private/sip2json_sdp.hpp" "Source: sip2json_sdp.hpp"
click HKS "https://github.com/SiddiqSoft/sip2json/blob/master/include/siddiqsoft/private/sip2json_header_keys.hpp" "Source: sip2json_header_keys.hpp"
click Exc "https://github.com/SiddiqSoft/sip2json/blob/master/include/siddiqsoft/private/sip2json_exception.hpp" "Source: sip2json_exception.hpp"Stream Parsing & Control Flow¶
sequenceDiagram
autonumber
actor App as Caller / Transport
participant S2J as siddiqsoft::sip2json
participant Parser as sip2json_parser
participant HKS as sip2json_header_keys
participant SDP as sip2json_sdp
participant Msg as siddiqsoft::sipmessage
App->>S2J: parseAsync(frameBuffer, onMsg, onErr)
activate S2J
loop While CRLF delimiter present in buffer
S2J->>Parser: parseStartLine(sipm, buffer)
alt Invalid start line
Parser-->>S2J: framing failure
S2J->>App: onErr(invalid_startline_error, buffer)
else Valid Request or Response
Parser-->>S2J: populates start line (/s)
S2J->>Parser: parseHeaders(sipm, buffer)
loop For each header line
Parser->>HKS: hash_header_key(keyToken)
HKS-->>Parser: canonical name & alias mapping
Parser->>Msg: storeHeaderValue(canonKey, val)
end
opt Content-Length > 0
alt Content-Type == application/sdp
S2J->>SDP: parseSdp(sipm, bodyBuffer)
SDP->>Msg: populates structured SDP (/b/sdp)
else Raw Payload
S2J->>Msg: stores raw payload (/b/raw)
end
end
S2J->>Msg: injects metadata (/meta)
S2J->>App: onMsg(std::move(sipm))
end
end
deactivate S2JNamespace Architecture & Package Boundaries¶
classDiagram
direction TB
classDef coreClass fill:rgba(35,73,109,0.08),stroke:#23496d,stroke-width:2px;
classDef utilityClass fill:rgba(15,118,110,0.08),stroke:#0f766e,stroke-width:2px;
classDef exceptionClass fill:rgba(185,28,28,0.06),stroke:#b91c1c,stroke-width:1.5px;
classDef enumClass fill:rgba(109,40,217,0.06),stroke:#6d28d9,stroke-width:1.5px;
classDef externalClass fill:rgba(100,116,139,0.06),stroke:#64748b,stroke-width:1.5px,stroke-dasharray: 4 3;
namespace siddiqsoft {
class sip2json
class sipmessage
class HeaderKeySet
class sip2jsonErrors
class sip2json_exception
class empty_message_error
class incomplete_buffer_for_content_error
class incomplete_buffer_for_header_error
class incomplete_buffer_for_parse_error
class invalid_document_error
class invalid_startline_error
class missing_required_element
class unsupported_contenttype_error
}
namespace nlohmann {
class json
}
namespace std {
class runtime_error
}
json <|-- sipmessage : public inheritance
runtime_error <|-- sip2json_exception : public inheritance
sip2json_exception <|-- empty_message_error
sip2json_exception <|-- incomplete_buffer_for_content_error
sip2json_exception <|-- incomplete_buffer_for_header_error
sip2json_exception <|-- incomplete_buffer_for_parse_error
sip2json_exception <|-- invalid_document_error
sip2json_exception <|-- invalid_startline_error
sip2json_exception <|-- missing_required_element
sip2json_exception <|-- unsupported_contenttype_error
sip2json ..> sipmessage : produces / consumes
sip2json ..> sip2json_exception : throws
sipmessage ..> HeaderKeySet : uses
sip2json_exception ..> sip2jsonErrors : contains
class sip2json:::utilityClass
class sipmessage:::coreClass
class HeaderKeySet:::coreClass
class sip2jsonErrors:::enumClass
class sip2json_exception:::exceptionClass
class empty_message_error:::exceptionClass
class incomplete_buffer_for_content_error:::exceptionClass
class incomplete_buffer_for_header_error:::exceptionClass
class incomplete_buffer_for_parse_error:::exceptionClass
class invalid_document_error:::exceptionClass
class invalid_startline_error:::exceptionClass
class missing_required_element:::exceptionClass
class unsupported_contenttype_error:::exceptionClass
class json:::externalClass
class runtime_error:::externalClass
link sip2json "https://github.com/SiddiqSoft/sip2json/blob/master/include/siddiqsoft/sip2json.hpp" "Source: include/siddiqsoft/sip2json.hpp"
link sipmessage "https://github.com/SiddiqSoft/sip2json/blob/master/include/siddiqsoft/sipmessage.hpp" "Source: include/siddiqsoft/sipmessage.hpp"
link HeaderKeySet "https://github.com/SiddiqSoft/sip2json/blob/master/include/siddiqsoft/private/sip2json_header_keys.hpp" "Source: include/siddiqsoft/private/sip2json_header_keys.hpp"
link sip2json_exception "https://github.com/SiddiqSoft/sip2json/blob/master/include/siddiqsoft/private/sip2json_exception.hpp" "Source: include/siddiqsoft/private/sip2json_exception.hpp"
link sip2jsonErrors "https://github.com/SiddiqSoft/sip2json/blob/master/include/siddiqsoft/private/sip2json_exception.hpp" "Source: include/siddiqsoft/private/sip2json_exception.hpp"
link empty_message_error "https://github.com/SiddiqSoft/sip2json/blob/master/include/siddiqsoft/private/sip2json_exception.hpp" "Source: include/siddiqsoft/private/sip2json_exception.hpp"
link incomplete_buffer_for_content_error "https://github.com/SiddiqSoft/sip2json/blob/master/include/siddiqsoft/private/sip2json_exception.hpp" "Source: include/siddiqsoft/private/sip2json_exception.hpp"
link incomplete_buffer_for_header_error "https://github.com/SiddiqSoft/sip2json/blob/master/include/siddiqsoft/private/sip2json_exception.hpp" "Source: include/siddiqsoft/private/sip2json_exception.hpp"
link incomplete_buffer_for_parse_error "https://github.com/SiddiqSoft/sip2json/blob/master/include/siddiqsoft/private/sip2json_exception.hpp" "Source: include/siddiqsoft/private/sip2json_exception.hpp"
link invalid_document_error "https://github.com/SiddiqSoft/sip2json/blob/master/include/siddiqsoft/private/sip2json_exception.hpp" "Source: include/siddiqsoft/private/sip2json_exception.hpp"
link invalid_startline_error "https://github.com/SiddiqSoft/sip2json/blob/master/include/siddiqsoft/private/sip2json_exception.hpp" "Source: include/siddiqsoft/private/sip2json_exception.hpp"
link missing_required_element "https://github.com/SiddiqSoft/sip2json/blob/master/include/siddiqsoft/private/sip2json_exception.hpp" "Source: include/siddiqsoft/private/sip2json_exception.hpp"
link unsupported_contenttype_error "https://github.com/SiddiqSoft/sip2json/blob/master/include/siddiqsoft/private/sip2json_exception.hpp" "Source: include/siddiqsoft/private/sip2json_exception.hpp"
link json "https://github.com/nlohmann/json" "External: nlohmann/json"
link runtime_error "https://en.cppreference.com/w/cpp/error/runtime_error" "Standard Library: std::runtime_error"UML Class Diagram¶
classDiagram
direction TB
classDef coreClass fill:rgba(35,73,109,0.08),stroke:#23496d,stroke-width:2px;
classDef utilityClass fill:rgba(15,118,110,0.08),stroke:#0f766e,stroke-width:2px;
classDef exceptionClass fill:rgba(185,28,28,0.06),stroke:#b91c1c,stroke-width:1.5px;
classDef enumClass fill:rgba(109,40,217,0.06),stroke:#6d28d9,stroke-width:1.5px;
classDef externalClass fill:rgba(100,116,139,0.06),stroke:#64748b,stroke-width:1.5px,stroke-dasharray: 4 3;
classDef highlightClass fill:rgba(2,132,199,0.18),stroke:#0284c7,stroke-width:3px;
class json["nlohmann::json"] {
<<external DOM>>
}
class json:::externalClass
class runtime_error["std::runtime_error"] {
<<external exception>>
}
class runtime_error:::externalClass
class sip2json["siddiqsoft::sip2json"] {
<<final utility>>
+parseAsync(string_view& frameBuffer, callback parseCallback, callback errorCallback)$ size_t
+parse(string_view& buffer)$ vector~sipmessage~
+parseFromBuffer(string_view& buffer)$ sipmessage
+serialize(sipmessage& sipm)$ string
}
class sip2json:::utilityClass
class sipmessage["siddiqsoft::sipmessage"] {
+sipmessage()
+headers() auto&
+getHeader(string& key, optional~T~ defaultValue) auto
+hasHeader(string_view key) bool
+setUserAgent(string& ua) auto&
+getUserAgent() auto
+getContentLength() uint32_t
+getExpires() uint32_t
+getContentTypeView() string_view
+getContentType() string
+getCallID() auto
+getMethod() auto
+getUri() auto
+getMethodView() string_view
+getUriView() string_view
+getReasonView() string_view
+getCallIDView() string_view
+getStatusCode() auto
+getReason() auto
+body() auto&
+hasBody() bool
+getBodyElement(json_pointer& jp, T& defaultValue) T
+isMessageRequest() bool
+isMessageResponse() bool
+setHeader(string& key, T& v) sipmessage&
+setBody(json_pointer& key, T& v) sipmessage&
}
class sipmessage:::coreClass
class HeaderKeySet["siddiqsoft::HeaderKeySet"] {
+bool isCanonical
+bool isMultiLine
+bool isCustom
+HeaderKeySet() constexpr
+canonical() string&
+lower() string&
+alt() string&
}
class HeaderKeySet:::coreClass
class SIPMessageType["siddiqsoft::SIPMessageType"] {
<<enumeration>>
notspecified
request = 1
response = 2
}
class SIPMessageType:::enumClass
class sip2jsonErrors["siddiqsoft::sip2jsonErrors"] {
<<enumeration>>
ok = 0
incomplete_buffer_for_parse
incomplete_buffer_for_content
incomplete_buffer_for_header
invalid_startline
unsupported_contenttype
missing_required_element
invalid_document
invalid_document_unsupported_method
invalid_document_unsupported_content
empty_message
unknown = 0xFFFFFFFF
}
class sip2jsonErrors:::enumClass
class sip2json_exception["siddiqsoft::sip2json_exception"] {
+sip2jsonErrors errCode
+sip2json_exception(string& msg)
}
class sip2json_exception:::exceptionClass
class empty_message_error["siddiqsoft::empty_message_error"]
class empty_message_error:::exceptionClass
class incomplete_buffer_for_content_error["siddiqsoft::incomplete_buffer_for_content_error"]
class incomplete_buffer_for_content_error:::exceptionClass
class incomplete_buffer_for_header_error["siddiqsoft::incomplete_buffer_for_header_error"]
class incomplete_buffer_for_header_error:::exceptionClass
class incomplete_buffer_for_parse_error["siddiqsoft::incomplete_buffer_for_parse_error"]
class incomplete_buffer_for_parse_error:::exceptionClass
class invalid_document_error["siddiqsoft::invalid_document_error"]
class invalid_document_error:::exceptionClass
class invalid_startline_error["siddiqsoft::invalid_startline_error"]
class invalid_startline_error:::exceptionClass
class missing_required_element["siddiqsoft::missing_required_element"]
class missing_required_element:::exceptionClass
class unsupported_contenttype_error["siddiqsoft::unsupported_contenttype_error"]
class unsupported_contenttype_error:::exceptionClass
json <|-- sipmessage : public inheritance
runtime_error <|-- sip2json_exception : public inheritance
sip2json_exception <|-- empty_message_error
sip2json_exception <|-- incomplete_buffer_for_content_error
sip2json_exception <|-- incomplete_buffer_for_header_error
sip2json_exception <|-- incomplete_buffer_for_parse_error
sip2json_exception <|-- invalid_document_error
sip2json_exception <|-- invalid_startline_error
sip2json_exception <|-- missing_required_element
sip2json_exception <|-- unsupported_contenttype_error
sip2json ..> sipmessage : produces / consumes
sip2json ..> sip2json_exception : throws
sipmessage ..> SIPMessageType : classifies
sipmessage ..> HeaderKeySet : uses
sip2json_exception ..> sip2jsonErrors : contains
link sip2json "https://github.com/SiddiqSoft/sip2json/blob/master/include/siddiqsoft/sip2json.hpp" "Source: include/siddiqsoft/sip2json.hpp"
link sipmessage "https://github.com/SiddiqSoft/sip2json/blob/master/include/siddiqsoft/sipmessage.hpp" "Source: include/siddiqsoft/sipmessage.hpp"
link HeaderKeySet "https://github.com/SiddiqSoft/sip2json/blob/master/include/siddiqsoft/private/sip2json_header_keys.hpp" "Source: include/siddiqsoft/private/sip2json_header_keys.hpp"
link sip2json_exception "https://github.com/SiddiqSoft/sip2json/blob/master/include/siddiqsoft/private/sip2json_exception.hpp" "Source: include/siddiqsoft/private/sip2json_exception.hpp"
link SIPMessageType "https://github.com/SiddiqSoft/sip2json/blob/master/include/siddiqsoft/sipmessage.hpp" "Source: include/siddiqsoft/sipmessage.hpp"
link sip2jsonErrors "https://github.com/SiddiqSoft/sip2json/blob/master/include/siddiqsoft/private/sip2json_exception.hpp" "Source: include/siddiqsoft/private/sip2json_exception.hpp"
link empty_message_error "https://github.com/SiddiqSoft/sip2json/blob/master/include/siddiqsoft/private/sip2json_exception.hpp" "Source: include/siddiqsoft/private/sip2json_exception.hpp"
link incomplete_buffer_for_content_error "https://github.com/SiddiqSoft/sip2json/blob/master/include/siddiqsoft/private/sip2json_exception.hpp" "Source: include/siddiqsoft/private/sip2json_exception.hpp"
link incomplete_buffer_for_header_error "https://github.com/SiddiqSoft/sip2json/blob/master/include/siddiqsoft/private/sip2json_exception.hpp" "Source: include/siddiqsoft/private/sip2json_exception.hpp"
link incomplete_buffer_for_parse_error "https://github.com/SiddiqSoft/sip2json/blob/master/include/siddiqsoft/private/sip2json_exception.hpp" "Source: include/siddiqsoft/private/sip2json_exception.hpp"
link invalid_document_error "https://github.com/SiddiqSoft/sip2json/blob/master/include/siddiqsoft/private/sip2json_exception.hpp" "Source: include/siddiqsoft/private/sip2json_exception.hpp"
link invalid_startline_error "https://github.com/SiddiqSoft/sip2json/blob/master/include/siddiqsoft/private/sip2json_exception.hpp" "Source: include/siddiqsoft/private/sip2json_exception.hpp"
link missing_required_element "https://github.com/SiddiqSoft/sip2json/blob/master/include/siddiqsoft/private/sip2json_exception.hpp" "Source: include/siddiqsoft/private/sip2json_exception.hpp"
link unsupported_contenttype_error "https://github.com/SiddiqSoft/sip2json/blob/master/include/siddiqsoft/private/sip2json_exception.hpp" "Source: include/siddiqsoft/private/sip2json_exception.hpp"
link json "https://github.com/nlohmann/json" "External: nlohmann/json"
link runtime_error "https://en.cppreference.com/w/cpp/error/runtime_error" "Standard Library: std::runtime_error"Source Code Mapping¶
Source Code Mapping¶
| Component / Class | Header File | Source Link | Purpose & Architectural Role |
|---|---|---|---|
siddiqsoft::sip2json |
include/siddiqsoft/ |
sip2json.hpp |
Top-level static parser, stream deserializer, and wire serializer utility |
siddiqsoft::sipmessage |
include/siddiqsoft/ |
sipmessage.hpp |
Core message container inheriting from nlohmann::json with zero-copy view accessors |
siddiqsoft::HeaderKeySet |
include/siddiqsoft/private/ |
sip2json_header_keys.hpp |
Canonical SIP header normalization, compact alias mapping, and compile-time hashing |
siddiqsoft::SIPMessageType |
include/siddiqsoft/ |
sipmessage.hpp |
Protocol message discriminator (Request = 1, Response = 2) |
siddiqsoft::sip2json_exception |
include/siddiqsoft/private/ |
sip2json_exception.hpp |
Base exception class inheriting from std::runtime_error with sip2jsonErrors payload |
siddiqsoft::sip2jsonErrors |
include/siddiqsoft/private/ |
sip2json_exception.hpp |
Diagnostic error code enumeration for parser and syntax failures |
| Derived Exceptions | include/siddiqsoft/private/ |
sip2json_exception.hpp |
Specialized exception hierarchy (invalid_document_error, empty_message_error, etc.) |
Parser Engine (raw_view) |
include/siddiqsoft/private/ |
sip2json_parser.hpp |
High-throughput streaming parser, zero-copy buffer slicing, CRLF boundary scanning |
| Wire Serializer | include/siddiqsoft/private/ |
sip2json_serializer.hpp |
RFC 3261 compliant text wire serializer |
| SDP Body Parser | include/siddiqsoft/private/ |
sip2json_sdp.hpp |
RFC 4566 Session Description Protocol parser and structured JSON serialization |
| Response Codes | include/siddiqsoft/private/ |
sip2json_response_codes.hpp |
SIP status codes, reason phrases, and classification ranges (1xx-6xx) |
| Protocol Constants | include/siddiqsoft/private/ |
sip2json_constants.hpp |
SIP grammar tokens, method strings, whitespace matchers, CRLF constants |
| DateTime Parser | include/siddiqsoft/private/ |
sip2json_datetime.hpp |
RFC 3261 / RFC 1123 HTTP-date timestamp parser and serializer |
| Utility Functions | include/siddiqsoft/private/ |
sip2json_utils.hpp |
Internal whitespace trimming, view slicing, string conversion utilities |
Component Breakdown & File Mapping¶
| Component | File Path | Class / Responsibility |
|---|---|---|
| Parser & Serializer Facade | siddiqsoft/ |
Static entry-point class siddiqsoft::sip2json for streaming, buffer consumption, and wire serialization. |
| Message DTO | siddiqsoft/ |
Document model siddiqsoft::sipmessage extending nlohmann::json with typed accessors. |
| Stream Parser Engine | siddiqsoft/private/ |
High-throughput linear token scanner for start line, headers, and payload dispatch. |
| Wire Serializer Engine | siddiqsoft/private/ |
RFC 3261 compliance serializer formatting headers and body into CRLF-separated byte streams. |
| SDP Processor | siddiqsoft/private/ |
RFC 4566 / RFC 8866 Session Description Protocol parser and JSON serializer. |
| Diagnostic Errors | siddiqsoft/private/ |
Exception siddiqsoft::sip2json_exception (derives std::runtime_error) and sip2jsonErrors. |
| Header Key Dispatch | siddiqsoft/private/ |
Case-insensitive mapping and compact single-character alias expansion. |
| Protocol Constants | siddiqsoft/private/ |
RFC 3261 standard method identifiers, version literals, and syntax delimiters. |
| Status Codes | siddiqsoft/private/ |
Numeric status code definitions (100-699) and reason phrase lookup tables. |
| Timestamp Utilities | siddiqsoft/private/ |
High-precision ISO 8601 and RFC 1123 datetime generators for message metadata. |
| Buffer Utilities | siddiqsoft/private/ |
Zero-copy string view trimming, token escaping, and delimiter searching helpers. |
Modular Header Layout¶
sip2json separates public interfaces from private implementation details under include/siddiqsoft/:
include/siddiqsoft/
|-- sip2json.hpp # Public entry-point header
|-- sipmessage.hpp # Primary SIP message DTO class
\-- private/ # Internal implementation headers
|-- sip2json_exception.hpp # Error code enums & exception classes
|-- sip2json_parser.hpp # Start-line, header & buffer parsing
|-- sip2json_response_codes.hpp # SIP status code to reason phrase mapping
|-- sip2json_sdp.hpp # SDP body parsing & serialization helpers
|-- sip2json_serializer.hpp # SIP message wire-format serialization
\-- sip2json_utils.hpp # Utilities, hashing & date formatters
Out-of-Scope Capabilities¶
To maintain a zero-dependency header-only architecture and maximum runtime efficiency, sip2json deliberately excludes:
- I/O Facilities: Network sockets, event loops, and buffer management are handled by your host networking engine (ASIO, libuv, epoll, Windows Sockets).
- Dialog State Machine & CSeq Tracking: The parser is stateless; call states and dialog transactions are tracked at the application layer.
- Encryption / TLS: TLS termination is handled at the transport layer before passing cleartext stream buffers to
sip2json.
Architecture & Design Topics¶
Performance & Benchmarks¶
Multi-platform pipeline build benchmarks, per-message processing latency, and cross-platform comparative metrics.
Stream Parsing & Buffer Management¶
Continuous TCP/TLS stream mechanics, iterator buffer progression, move semantics (sipmessage&&), and memory lifetime rules.
Optimization Choices¶
Clean JavaScript-like C++20 API design, FNV-1 header matching, and protocol-specific optimization choices.
Standards Compliance¶
Concurrence with RFC 3261, RFC 4475 (SIP Torture 50 test cases), RFC 4566/8866 (SDP), and WebRTC specifications.
Test Suite & RFC Reference¶
Section-by-section mapping of test runner files, sample fixtures, and direct links to official IETF specifications.