/  Yamcs HTTP API  /  Server  /  Subscribe Http Traffic

Subscribe Http TrafficΒΆ

Receive HTTP traffic updates

WebSocket

This method requires to upgrade an HTTP connection to WebSocket. See details on how Yamcs uses WebSocket.

Use the message type http-traffic.

Output Type

interface HttpTraffic {
  readBytes: string;  // String decimal
  writtenBytes: string;  // String decimal
  readThroughput: string;  // String decimal
  writeThroughput: string;  // String decimal
  connections: ClientConnectionInfo[];
}

Related Types

interface ClientConnectionInfo {
  id: string;
  open: boolean;
  active: boolean;
  writable: boolean;
  remoteAddress: string;
  readBytes: string;  // String decimal
  writtenBytes: string;  // String decimal
  readThroughput: string;  // String decimal
  writeThroughput: string;  // String decimal
  httpRequest: HttpRequestInfo;
  username: string;
}

interface HttpRequestInfo {
  protocol: string;
  method: string;
  uri: string;
  keepAlive: boolean;
  userAgent: string;
}