@aster-rpc/aster API Reference
    Preparing search index...

    Class AsterServer

    High-level Aster RPC server.

    Creates an IrohNode, serves RPC over QUIC, handles consumer admission, and prints a startup banner.

    const server = new AsterServer({
      services: [new MissionControl()],
    });
    await server.start();
    console.log(server.address);
    await server.serve();
    Index

    Accessors

    address endpointId running services

    Constructors

    constructor

    Methods

    start serve close localTransport

    Properties

    registry config logger

    Accessors

    • get address(): string

      The aster1... connection address for clients.

      Returns string

    • get endpointId(): string

      Hex endpoint ID of this server's node.

      Returns string

    • get running(): boolean

      Whether the server is running.

      Returns boolean

    • get services(): ServiceSummary[]

      List of services hosted by this server.

      Returns ServiceSummary[]

    Constructors

    Methods

    • Create the IrohNode and prepare for serving. Idempotent.

      Returns Promise<void>

    • Start accepting connections. Blocks until close() is called.

      Returns Promise<void>

    • Stop accepting connections and close the node.

      Returns Promise<void>

    • Create a local in-process transport for testing.

      Returns LocalTransport

    Properties

    registry: ServiceRegistry
    config: AsterConfig
    logger: AsterLogger

    Settings

    Member Visibility

    On This Page

    Accessors
    Constructors
    Methods
    Properties