Variable AppDaemonConst

AppDaemon: {
    methods: {
        connect: {
            I: typeof ConnectRequest;
            O: typeof ConnectResponse;
            kind: Unary;
            name: "Connect";
        };
        disconnect: {
            I: typeof DisconnectRequest;
            O: typeof DisconnectResponse;
            kind: Unary;
            name: "Disconnect";
        };
        dropConnection: {
            I: typeof DropConnectionRequest;
            O: typeof DropConnectionResponse;
            kind: Unary;
            name: "DropConnection";
        };
        getConnection: {
            I: typeof GetConnectionRequest;
            O: typeof GetConnectionResponse;
            kind: Unary;
            name: "GetConnection";
        };
        listConnections: {
            I: typeof ListConnectionsRequest;
            O: typeof ListConnectionsResponse;
            kind: Unary;
            name: "ListConnections";
        };
        metrics: {
            I: typeof MetricsRequest;
            O: typeof MetricsResponse;
            kind: Unary;
            name: "Metrics";
        };
        putConnection: {
            I: typeof PutConnectionRequest;
            O: typeof PutConnectionResponse;
            kind: Unary;
            name: "PutConnection";
        };
        query: {
            I: typeof AppQueryRequest;
            O: typeof QueryResponse;
            kind: Unary;
            name: "Query";
        };
        status: {
            I: typeof StatusRequest;
            O: typeof DaemonStatus;
            kind: Unary;
            name: "Status";
        };
    };
    typeName: "v1.AppDaemon";
} = ...

AppDaemon is exposed by nodes running in the daemon mode. This mode allows the node to run in an idle state and be controlled by an application. The application can send commands to the node to execute tasks and receive responses.

Type declaration

  • Readonly methods: {
        connect: {
            I: typeof ConnectRequest;
            O: typeof ConnectResponse;
            kind: Unary;
            name: "Connect";
        };
        disconnect: {
            I: typeof DisconnectRequest;
            O: typeof DisconnectResponse;
            kind: Unary;
            name: "Disconnect";
        };
        dropConnection: {
            I: typeof DropConnectionRequest;
            O: typeof DropConnectionResponse;
            kind: Unary;
            name: "DropConnection";
        };
        getConnection: {
            I: typeof GetConnectionRequest;
            O: typeof GetConnectionResponse;
            kind: Unary;
            name: "GetConnection";
        };
        listConnections: {
            I: typeof ListConnectionsRequest;
            O: typeof ListConnectionsResponse;
            kind: Unary;
            name: "ListConnections";
        };
        metrics: {
            I: typeof MetricsRequest;
            O: typeof MetricsResponse;
            kind: Unary;
            name: "Metrics";
        };
        putConnection: {
            I: typeof PutConnectionRequest;
            O: typeof PutConnectionResponse;
            kind: Unary;
            name: "PutConnection";
        };
        query: {
            I: typeof AppQueryRequest;
            O: typeof QueryResponse;
            kind: Unary;
            name: "Query";
        };
        status: {
            I: typeof StatusRequest;
            O: typeof DaemonStatus;
            kind: Unary;
            name: "Status";
        };
    }
    • Readonly connect: {
          I: typeof ConnectRequest;
          O: typeof ConnectResponse;
          kind: Unary;
          name: "Connect";
      }

      Connect is used to establish a connection between the node and a mesh.

      Generated

      from rpc v1.AppDaemon.Connect

      • Readonly I: typeof ConnectRequest
      • Readonly O: typeof ConnectResponse
      • Readonly kind: Unary
      • Readonly name: "Connect"
    • Readonly disconnect: {
          I: typeof DisconnectRequest;
          O: typeof DisconnectResponse;
          kind: Unary;
          name: "Disconnect";
      }

      Disconnect is used to disconnect the node from a mesh.

      Generated

      from rpc v1.AppDaemon.Disconnect

      • Readonly I: typeof DisconnectRequest
      • Readonly O: typeof DisconnectResponse
      • Readonly kind: Unary
      • Readonly name: "Disconnect"
    • Readonly dropConnection: {
          I: typeof DropConnectionRequest;
          O: typeof DropConnectionResponse;
          kind: Unary;
          name: "DropConnection";
      }

      DropConnection deletes all data stored for a given mesh connection.

      Generated

      from rpc v1.AppDaemon.DropConnection

      • Readonly I: typeof DropConnectionRequest
      • Readonly O: typeof DropConnectionResponse
      • Readonly kind: Unary
      • Readonly name: "DropConnection"
    • Readonly getConnection: {
          I: typeof GetConnectionRequest;
          O: typeof GetConnectionResponse;
          kind: Unary;
          name: "GetConnection";
      }

      GetConnection retrieves the parameters and current status of a connection in the daemon.

      Generated

      from rpc v1.AppDaemon.GetConnection

      • Readonly I: typeof GetConnectionRequest
      • Readonly O: typeof GetConnectionResponse
      • Readonly kind: Unary
      • Readonly name: "GetConnection"
    • Readonly listConnections: {
          I: typeof ListConnectionsRequest;
          O: typeof ListConnectionsResponse;
          kind: Unary;
          name: "ListConnections";
      }

      ListConnections retrieves the parameters and current status of all connections in the daemon.

      Generated

      from rpc v1.AppDaemon.ListConnections

      • Readonly I: typeof ListConnectionsRequest
      • Readonly O: typeof ListConnectionsResponse
      • Readonly kind: Unary
      • Readonly name: "ListConnections"
    • Readonly metrics: {
          I: typeof MetricsRequest;
          O: typeof MetricsResponse;
          kind: Unary;
          name: "Metrics";
      }

      Metrics is used to retrieve interface metrics for one or more mesh connections.

      Generated

      from rpc v1.AppDaemon.Metrics

      • Readonly I: typeof MetricsRequest
      • Readonly O: typeof MetricsResponse
      • Readonly kind: Unary
      • Readonly name: "Metrics"
    • Readonly putConnection: {
          I: typeof PutConnectionRequest;
          O: typeof PutConnectionResponse;
          kind: Unary;
          name: "PutConnection";
      }

      PutConnection stores the parameters for a connection in the daemon.

      Generated

      from rpc v1.AppDaemon.PutConnection

      • Readonly I: typeof PutConnectionRequest
      • Readonly O: typeof PutConnectionResponse
      • Readonly kind: Unary
      • Readonly name: "PutConnection"
    • Readonly query: {
          I: typeof AppQueryRequest;
          O: typeof QueryResponse;
          kind: Unary;
          name: "Query";
      }

      Query is used to query a mesh connection for information.

      Generated

      from rpc v1.AppDaemon.Query

      • Readonly I: typeof AppQueryRequest
      • Readonly O: typeof QueryResponse
      • Readonly kind: Unary
      • Readonly name: "Query"
    • Readonly status: {
          I: typeof StatusRequest;
          O: typeof DaemonStatus;
          kind: Unary;
          name: "Status";
      }

      Status is used to retrieve the status of the daemon. This includes a map of known connections and their statuses.

      Generated

      from rpc v1.AppDaemon.Status

      • Readonly I: typeof StatusRequest
      • Readonly O: typeof DaemonStatus
      • Readonly kind: Unary
      • Readonly name: "Status"
  • Readonly typeName: "v1.AppDaemon"

Generated

from service v1.AppDaemon

Generated using TypeDoc