Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RequestStream

Interface which specifies a request stream to receive request notifications.

Hierarchy

  • RequestStream

Index

Methods

onClose

  • onClose(): void
  • Called when the request stream is removed, or the session is closed.

    Returns void

onError

  • Notification of a contextual error related to this stream. This is analogous to an Error being thrown. Situations in which onError is called include being unable to parse the request with the data type the stream was registered with. No further calls will be made to this stream.

    Parameters

    Returns void

onRequest

  • onRequest(path: string, request: any, responder: Responder): void
  • Called to indicate a request has been received.

    Parameters

    • path: string

      the path the request was sent on

    • request: any

      the request that was received

    • responder: Responder

      the responder to dispatch a response back to the requester

    Returns void