@hla4ts/transport 0.1.0 → 0.1.1

package/src/message-header.ts

@@ -1,141 +1,141 @@
-/**
- * Federate Protocol Message Header
- *
- * The message header is a 24-byte structure that precedes every message
- * in the Federate Protocol. It contains:
- *
- * - packetSize (4 bytes): Total size of the packet including header
- * - sequenceNumber (4 bytes): Monotonically increasing sequence number
- * - sessionId (8 bytes): Unique session identifier
- * - lastReceivedSequenceNumber (4 bytes): ACK for flow control
- * - messageType (4 bytes): Type of message (see MessageType enum)
- */
-
-import { MessageType } from "./message-type.ts";
-
-/** Size of the message header in bytes */
-export const HEADER_SIZE = 24;
-
-/** Special value indicating no session ID */
-export const NO_SESSION_ID = 0n;
-
-/** Special value indicating no sequence number */
-export const NO_SEQUENCE_NUMBER = 0;
-
-/**
- * Decoded message header
- */
-export interface MessageHeader {
-  /** Total packet size including header */
-  packetSize: number;
-  /** Message sequence number */
-  sequenceNumber: number;
-  /** Session identifier */
-  sessionId: bigint;
-  /** Last received sequence number (for ACK) */
-  lastReceivedSequenceNumber: number;
-  /** Type of message */
-  messageType: MessageType;
-}
-
-/**
- * Encode a message header into a 24-byte buffer
- */
-export function encodeHeader(
-  payloadSize: number,
-  sequenceNumber: number,
-  sessionId: bigint,
-  lastReceivedSequenceNumber: number,
-  messageType: MessageType
-): Uint8Array {
-  const packetSize = HEADER_SIZE + payloadSize;
-  const buffer = new ArrayBuffer(HEADER_SIZE);
-  const view = new DataView(buffer);
-
-  // All values are big-endian (network byte order)
-  view.setUint32(0, packetSize, false);
-  view.setUint32(4, sequenceNumber, false);
-  view.setBigUint64(8, sessionId, false);
-  view.setUint32(16, lastReceivedSequenceNumber, false);
-  view.setUint32(20, messageType, false);
-
-  return new Uint8Array(buffer);
-}
-
-/**
- * Decode a message header from a 24-byte buffer
- * @throws Error if buffer is too small or contains invalid data
- */
-export function decodeHeader(buffer: Uint8Array): MessageHeader {
-  if (buffer.length < HEADER_SIZE) {
-    throw new Error(
-      `Buffer too small for header: expected ${HEADER_SIZE} bytes, got ${buffer.length}`
-    );
-  }
-
-  const view = new DataView(
-    buffer.buffer,
-    buffer.byteOffset,
-    buffer.byteLength
-  );
-
-  const packetSize = view.getUint32(0, false);
-  if (packetSize < HEADER_SIZE) {
-    throw new Error(`Invalid packet size: ${packetSize} (minimum is ${HEADER_SIZE})`);
-  }
-
-  const sequenceNumber = view.getUint32(4, false);
-  const sessionId = view.getBigUint64(8, false);
-  const lastReceivedSequenceNumber = view.getUint32(16, false);
-  const messageTypeValue = view.getUint32(20, false);
-
-  // Validate message type
-  if (!Object.values(MessageType).includes(messageTypeValue)) {
-    throw new Error(`Unknown message type: ${messageTypeValue}`);
-  }
-
-  return {
-    packetSize,
-    sequenceNumber,
-    sessionId,
-    lastReceivedSequenceNumber,
-    messageType: messageTypeValue as MessageType,
-  };
-}
-
-/**
- * Get the payload size from a header
- */
-export function getPayloadSize(header: MessageHeader): number {
-  return header.packetSize - HEADER_SIZE;
-}
-
-/**
- * Encode a complete message (header + payload)
- */
-export function encodeMessage(
-  sequenceNumber: number,
-  sessionId: bigint,
-  lastReceivedSequenceNumber: number,
-  messageType: MessageType,
-  payload?: Uint8Array
-): Uint8Array {
-  const payloadSize = payload?.length ?? 0;
-  const header = encodeHeader(
-    payloadSize,
-    sequenceNumber,
-    sessionId,
-    lastReceivedSequenceNumber,
-    messageType
-  );
-
-  if (payloadSize === 0) {
-    return header;
-  }
-
-  // Combine header and payload
-  const message = new Uint8Array(HEADER_SIZE + payloadSize);
-  message.set(header, 0);
-  message.set(payload!, HEADER_SIZE);
-  return message;
-}
+/**
+ * Federate Protocol Message Header
+ *
+ * The message header is a 24-byte structure that precedes every message
+ * in the Federate Protocol. It contains:
+ *
+ * - packetSize (4 bytes): Total size of the packet including header
+ * - sequenceNumber (4 bytes): Monotonically increasing sequence number
+ * - sessionId (8 bytes): Unique session identifier
+ * - lastReceivedSequenceNumber (4 bytes): ACK for flow control
+ * - messageType (4 bytes): Type of message (see MessageType enum)
+ */
+
+import { MessageType } from "./message-type.ts";
+
+/** Size of the message header in bytes */
+export const HEADER_SIZE = 24;
+
+/** Special value indicating no session ID */
+export const NO_SESSION_ID = 0n;
+
+/** Special value indicating no sequence number */
+export const NO_SEQUENCE_NUMBER = 0;
+
+/**
+ * Decoded message header
+ */
+export interface MessageHeader {
+  /** Total packet size including header */
+  packetSize: number;
+  /** Message sequence number */
+  sequenceNumber: number;
+  /** Session identifier */
+  sessionId: bigint;
+  /** Last received sequence number (for ACK) */
+  lastReceivedSequenceNumber: number;
+  /** Type of message */
+  messageType: MessageType;
+}
+
+/**
+ * Encode a message header into a 24-byte buffer
+ */
+export function encodeHeader(
+  payloadSize: number,
+  sequenceNumber: number,
+  sessionId: bigint,
+  lastReceivedSequenceNumber: number,
+  messageType: MessageType
+): Uint8Array {
+  const packetSize = HEADER_SIZE + payloadSize;
+  const buffer = new ArrayBuffer(HEADER_SIZE);
+  const view = new DataView(buffer);
+
+  // All values are big-endian (network byte order)
+  view.setUint32(0, packetSize, false);
+  view.setUint32(4, sequenceNumber, false);
+  view.setBigUint64(8, sessionId, false);
+  view.setUint32(16, lastReceivedSequenceNumber, false);
+  view.setUint32(20, messageType, false);
+
+  return new Uint8Array(buffer);
+}
+
+/**
+ * Decode a message header from a 24-byte buffer
+ * @throws Error if buffer is too small or contains invalid data
+ */
+export function decodeHeader(buffer: Uint8Array): MessageHeader {
+  if (buffer.length < HEADER_SIZE) {
+    throw new Error(
+      `Buffer too small for header: expected ${HEADER_SIZE} bytes, got ${buffer.length}`
+    );
+  }
+
+  const view = new DataView(
+    buffer.buffer,
+    buffer.byteOffset,
+    buffer.byteLength
+  );
+
+  const packetSize = view.getUint32(0, false);
+  if (packetSize < HEADER_SIZE) {
+    throw new Error(`Invalid packet size: ${packetSize} (minimum is ${HEADER_SIZE})`);
+  }
+
+  const sequenceNumber = view.getUint32(4, false);
+  const sessionId = view.getBigUint64(8, false);
+  const lastReceivedSequenceNumber = view.getUint32(16, false);
+  const messageTypeValue = view.getUint32(20, false);
+
+  // Validate message type
+  if (!Object.values(MessageType).includes(messageTypeValue)) {
+    throw new Error(`Unknown message type: ${messageTypeValue}`);
+  }
+
+  return {
+    packetSize,
+    sequenceNumber,
+    sessionId,
+    lastReceivedSequenceNumber,
+    messageType: messageTypeValue as MessageType,
+  };
+}
+
+/**
+ * Get the payload size from a header
+ */
+export function getPayloadSize(header: MessageHeader): number {
+  return header.packetSize - HEADER_SIZE;
+}
+
+/**
+ * Encode a complete message (header + payload)
+ */
+export function encodeMessage(
+  sequenceNumber: number,
+  sessionId: bigint,
+  lastReceivedSequenceNumber: number,
+  messageType: MessageType,
+  payload?: Uint8Array
+): Uint8Array {
+  const payloadSize = payload?.length ?? 0;
+  const header = encodeHeader(
+    payloadSize,
+    sequenceNumber,
+    sessionId,
+    lastReceivedSequenceNumber,
+    messageType
+  );
+
+  if (payloadSize === 0) {
+    return header;
+  }
+
+  // Combine header and payload
+  const message = new Uint8Array(HEADER_SIZE + payloadSize);
+  message.set(header, 0);
+  message.set(payload!, HEADER_SIZE);
+  return message;
+}

package/src/message-type.ts

@@ -1,62 +1,62 @@
-/**
- * Federate Protocol Message Types
- *
- * These message types are defined in the IEEE 1516-2025 Federate Protocol specification.
- * They are used in the message header to indicate the type of message being sent.
- */
-
-export enum MessageType {
-  // Session Management (Control Messages)
-  /** Client → Server: Request to create a new session */
-  CTRL_NEW_SESSION = 1,
-  /** Server → Client: Response with session creation status */
-  CTRL_NEW_SESSION_STATUS = 2,
-  /** Bidirectional: Keep-alive ping */
-  CTRL_HEARTBEAT = 3,
-  /** Bidirectional: Keep-alive pong */
-  CTRL_HEARTBEAT_RESPONSE = 4,
-  /** Client → Server: Request to terminate session */
-  CTRL_TERMINATE_SESSION = 5,
-  /** Server → Client: Confirmation of session termination */
-  CTRL_SESSION_TERMINATED = 6,
-
-  // Reconnection
-  /** Client → Server: Request to resume a dropped session */
-  CTRL_RESUME_REQUEST = 10,
-  /** Server → Client: Response with resume status */
-  CTRL_RESUME_STATUS = 11,
-
-  // HLA Calls and Callbacks
-  /** Client → Server: HLA RTI service call (protobuf CallRequest) */
-  HLA_CALL_REQUEST = 20,
-  /** Server → Client: HLA RTI service response (protobuf CallResponse) */
-  HLA_CALL_RESPONSE = 21,
-  /** Server → Client: HLA callback to federate (protobuf CallbackRequest) */
-  HLA_CALLBACK_REQUEST = 22,
-  /** Client → Server: HLA callback acknowledgment (protobuf CallbackResponse) */
-  HLA_CALLBACK_RESPONSE = 23,
-}
-
-/**
- * Check if a message type is a control message (session management)
- */
-export function isControlMessage(type: MessageType): boolean {
-  return type < MessageType.HLA_CALL_REQUEST;
-}
-
-/**
- * Check if a message type is an HLA response
- */
-export function isHlaResponse(type: MessageType): boolean {
-  return (
-    type === MessageType.HLA_CALL_RESPONSE ||
-    type === MessageType.HLA_CALLBACK_RESPONSE
-  );
-}
-
-/**
- * Get a human-readable name for a message type
- */
-export function messageTypeName(type: MessageType): string {
-  return MessageType[type] ?? `UNKNOWN(${type})`;
-}
+/**
+ * Federate Protocol Message Types
+ *
+ * These message types are defined in the IEEE 1516-2025 Federate Protocol specification.
+ * They are used in the message header to indicate the type of message being sent.
+ */
+
+export enum MessageType {
+  // Session Management (Control Messages)
+  /** Client → Server: Request to create a new session */
+  CTRL_NEW_SESSION = 1,
+  /** Server → Client: Response with session creation status */
+  CTRL_NEW_SESSION_STATUS = 2,
+  /** Bidirectional: Keep-alive ping */
+  CTRL_HEARTBEAT = 3,
+  /** Bidirectional: Keep-alive pong */
+  CTRL_HEARTBEAT_RESPONSE = 4,
+  /** Client → Server: Request to terminate session */
+  CTRL_TERMINATE_SESSION = 5,
+  /** Server → Client: Confirmation of session termination */
+  CTRL_SESSION_TERMINATED = 6,
+
+  // Reconnection
+  /** Client → Server: Request to resume a dropped session */
+  CTRL_RESUME_REQUEST = 10,
+  /** Server → Client: Response with resume status */
+  CTRL_RESUME_STATUS = 11,
+
+  // HLA Calls and Callbacks
+  /** Client → Server: HLA RTI service call (protobuf CallRequest) */
+  HLA_CALL_REQUEST = 20,
+  /** Server → Client: HLA RTI service response (protobuf CallResponse) */
+  HLA_CALL_RESPONSE = 21,
+  /** Server → Client: HLA callback to federate (protobuf CallbackRequest) */
+  HLA_CALLBACK_REQUEST = 22,
+  /** Client → Server: HLA callback acknowledgment (protobuf CallbackResponse) */
+  HLA_CALLBACK_RESPONSE = 23,
+}
+
+/**
+ * Check if a message type is a control message (session management)
+ */
+export function isControlMessage(type: MessageType): boolean {
+  return type < MessageType.HLA_CALL_REQUEST;
+}
+
+/**
+ * Check if a message type is an HLA response
+ */
+export function isHlaResponse(type: MessageType): boolean {
+  return (
+    type === MessageType.HLA_CALL_RESPONSE ||
+    type === MessageType.HLA_CALLBACK_RESPONSE
+  );
+}
+
+/**
+ * Get a human-readable name for a message type
+ */
+export function messageTypeName(type: MessageType): string {
+  return MessageType[type] ?? `UNKNOWN(${type})`;
+}