Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "soap/accept"

Index

Functions

acceptObject

  • Accepts an object via Simple Offer/Accept Protocol from a peer.

    • Resolves to an AcceptedObject if an object was successfully accepted. The session may still be open after this function resolves.
    • Resolves to nothing if a session was never established.

    • Will reject if the session is closed before we are able to reply, even if we did not reply with any value. Will reject on protocol and other errors.

    A value to reply with may be provided via the args.reply option.

    Parameters

    Returns Promise<AcceptedObject | undefined>

beginAcceptObject

  • Accepts an object from a peer via Simple Offer/Accept Protocol but doesn't complete the exchange and send a reply to the peer until the resolve() method on the returned AcceptedObject is called (with optional response data)

    • Resolves with an AcceptedObject if the peer sent an object message to us.
    • Resolves to nothing if a session is never established.

    • Will reject on protocol and other errors.

    Parameters

    Returns Promise<AcceptedObject | undefined>

Generated using TypeDoc