Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FluencePeer

This class implements the Fluence protocol for javascript-based environments. It provides all the necessary features to communicate with Fluence network

Hierarchy

  • FluencePeer

Index

Constructors

Accessors

Methods

Constructors

constructor

Accessors

internals

  • get internals(): { callServiceHandler: CallServiceHandler; initiateFlow: (request: RequestFlow) => Promise<void> }

  • Is not intended to be used manually. Subject to change

    Returns { callServiceHandler: CallServiceHandler; initiateFlow: (request: RequestFlow) => Promise<void> }

    • callServiceHandler: CallServiceHandler
    • initiateFlow: (request: RequestFlow) => Promise<void>
        • (request: RequestFlow): Promise<void>

        • Parameters

          • request: RequestFlow

          Returns Promise<void>

Methods

getStatus

start

  • start(config?: PeerConfig): Promise<void>

  • Initializes the peer: starts the Aqua VM, initializes the default call service handlers and (optionally) connect to the Fluence network

    Parameters

    • Optional config: PeerConfig

      object specifying peer configuration

    Returns Promise<void>

stop

  • stop(): Promise<void>

  • Uninitializes the peer: stops all the underltying workflows, stops the Aqua VM and disconnects from the Fluence network

    Returns Promise<void>

Static isInstance

  • Checks whether the object is instance of FluencePeer class

    Parameters

    • obj: FluencePeer

      object to check if it is FluencePeer

    Returns boolean

    true if the object is FluencePeer false otherwise

Generated using TypeDoc