HttpApiDispatcher

Overview

Location

 

constructor

 

constructor

 

HttpApiDispatcher()

 

init()

 

Sub New()

Activate

 

method Activate

 

void Activate()

 

func Activate()

 

Sub Activate()

ApiHost

 

property ApiHost: String read write;

 

String ApiHost { get; set; }

 

var ApiHost: String { get{} set{} }

 

Property ApiHost() As String

ApiName

 

property ApiName: String read write;

 

String ApiName { get; set; }

 

var ApiName: String { get{} set{} }

 

Property ApiName() As String

ApiVersion

 

property ApiVersion: String read write;

 

String ApiVersion { get; set; }

 

var ApiVersion: String { get{} set{} }

 

Property ApiVersion() As String

AuthenticationManager

 

property AuthenticationManager: IApiAuthenticationManager read write;

 

IApiAuthenticationManager AuthenticationManager { get; set; }

 

var AuthenticationManager: IApiAuthenticationManager { get{} set{} }

 

Property AuthenticationManager() As IApiAuthenticationManager

CanHandlePath    (declared in ExtendedHttpDispatcher)

Checks if the provided relative HTTP request path can be processed by this dispatcher.

 

method CanHandlePath(path: String): Boolean

 

Boolean CanHandlePath(String path)

 

func CanHandlePath(_ path: String) -> Boolean

 

Function CanHandlePath(path As String) As Boolean

Parameters:

  • path:

Deactivate    (declared in ExtendedHttpDispatcher)

 

method Deactivate

 

void Deactivate()

 

func Deactivate()

 

Sub Deactivate()

Dispose  protected    (declared in ExtendedHttpDispatcher)

If the disposing parameter is set to true, this method unregisters this dispatcher instance from the server.

 

method Dispose(disposing: Boolean)

 

void Dispose(Boolean disposing)

 

func Dispose(_ disposing: Boolean)

 

Sub Dispose(disposing As Boolean)

Parameters:

  • disposing: If set to true, the current dispatcher instance will be unregistered from the server.

NotifyDispose    (declared in ExtendedHttpDispatcher)

This method is called when the ExtendedDispatcherList instance where the current instance is registered is disposed.

 

method NotifyDispose

 

void NotifyDispose()

 

func NotifyDispose()

 

Sub NotifyDispose()

Path    (declared in ExtendedHttpDispatcher)

Gets or sets the relative HTTP path requests that will be processed by the current HttpDispatcher instance.

Path should begin with "/".

 

property Path: String read write;

 

String Path { get; set; }

 

var Path: String { get{} set{} }

 

Property Path() As String

Process

 

method Process(context: IServerChannelInfo; request: IHttpRequest; response: IHttpResponse; requestData: Stream; responseData: Stream)

 

void Process(IServerChannelInfo context, IHttpRequest request, IHttpResponse response, Stream requestData, Stream responseData)

 

func Process(_ context: IServerChannelInfo, _ request: IHttpRequest, _ response: IHttpResponse, _ requestData: Stream, _ responseData: Stream)

 

Sub Process(context As IServerChannelInfo, request As IHttpRequest, response As IHttpResponse, requestData As Stream, responseData As Stream)

Parameters:

  • context:
  • request:
  • response:
  • requestData:
  • responseData:

Server    (declared in ExtendedHttpDispatcher)

The IHttpServer instance this dispatcher is registered in.

The ExtendedHttpDispatcher instance is automatically registered in the provided IHttpServer instance's extended dispatchers list when this property is set.

 

property Server: IHttpServer read write;

 

IHttpServer Server { get; set; }

 

var Server: IHttpServer { get{} set{} }

 

Property Server() As IHttpServer

 

ApiHost

 

property ApiHost: String read write;

 

String ApiHost { get; set; }

 

var ApiHost: String { get{} set{} }

 

Property ApiHost() As String

ApiName

 

property ApiName: String read write;

 

String ApiName { get; set; }

 

var ApiName: String { get{} set{} }

 

Property ApiName() As String

ApiVersion

 

property ApiVersion: String read write;

 

String ApiVersion { get; set; }

 

var ApiVersion: String { get{} set{} }

 

Property ApiVersion() As String

AuthenticationManager

 

property AuthenticationManager: IApiAuthenticationManager read write;

 

IApiAuthenticationManager AuthenticationManager { get; set; }

 

var AuthenticationManager: IApiAuthenticationManager { get{} set{} }

 

Property AuthenticationManager() As IApiAuthenticationManager

Path    (declared in ExtendedHttpDispatcher)

Gets or sets the relative HTTP path requests that will be processed by the current HttpDispatcher instance.

Path should begin with "/".

 

property Path: String read write;

 

String Path { get; set; }

 

var Path: String { get{} set{} }

 

Property Path() As String

Server    (declared in ExtendedHttpDispatcher)

The IHttpServer instance this dispatcher is registered in.

The ExtendedHttpDispatcher instance is automatically registered in the provided IHttpServer instance's extended dispatchers list when this property is set.

 

property Server: IHttpServer read write;

 

IHttpServer Server { get; set; }

 

var Server: IHttpServer { get{} set{} }

 

Property Server() As IHttpServer

 

constructor

 

constructor

 

HttpApiDispatcher()

 

init()

 

Sub New()

Activate

 

method Activate

 

void Activate()

 

func Activate()

 

Sub Activate()

CanHandlePath    (declared in ExtendedHttpDispatcher)

Checks if the provided relative HTTP request path can be processed by this dispatcher.

 

method CanHandlePath(path: String): Boolean

 

Boolean CanHandlePath(String path)

 

func CanHandlePath(_ path: String) -> Boolean

 

Function CanHandlePath(path As String) As Boolean

Parameters:

  • path:

Deactivate    (declared in ExtendedHttpDispatcher)

 

method Deactivate

 

void Deactivate()

 

func Deactivate()

 

Sub Deactivate()

Dispose  protected    (declared in ExtendedHttpDispatcher)

If the disposing parameter is set to true, this method unregisters this dispatcher instance from the server.

 

method Dispose(disposing: Boolean)

 

void Dispose(Boolean disposing)

 

func Dispose(_ disposing: Boolean)

 

Sub Dispose(disposing As Boolean)

Parameters:

  • disposing: If set to true, the current dispatcher instance will be unregistered from the server.

NotifyDispose    (declared in ExtendedHttpDispatcher)

This method is called when the ExtendedDispatcherList instance where the current instance is registered is disposed.

 

method NotifyDispose

 

void NotifyDispose()

 

func NotifyDispose()

 

Sub NotifyDispose()

Process

 

method Process(context: IServerChannelInfo; request: IHttpRequest; response: IHttpResponse; requestData: Stream; responseData: Stream)

 

void Process(IServerChannelInfo context, IHttpRequest request, IHttpResponse response, Stream requestData, Stream responseData)

 

func Process(_ context: IServerChannelInfo, _ request: IHttpRequest, _ response: IHttpResponse, _ requestData: Stream, _ responseData: Stream)

 

Sub Process(context As IServerChannelInfo, request As IHttpRequest, response As IHttpResponse, requestData As Stream, responseData As Stream)

Parameters:

  • context:
  • request:
  • response:
  • requestData:
  • responseData: