Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IConnectionManager

A ng service interface mainly handles the application's connections. This service uses IBackgroundProcessManager as background process executor for non-blocking network I/O. So, you can get alive connections using getRunningProcesses or getRunningProcessesCount method. All connections created via this service will be monitored the connection quality which will be displayed on user's screen. You can get the connection quality of the application by using method getConnectionQuality.

author

shiorin, tee4cute

see

IBackgroundProcessManager

Hierarchy

  • IConnectionManager

Implemented by

Index

Methods

Methods

createResource

  • createResource<R>(type: object): R

  • Type parameters

    Parameters

    • type: object

    Returns R

delete

  • delete(url: string, requestOptionsArgs: any): Promise<any>

  • Send DELETE request to the specified url.

    Parameters

    • url: string
    • requestOptionsArgs: any

    Returns Promise<any>

deleteWithHttpInfo

  • deleteWithHttpInfo(url: string, requestOptionsArgs: any): Promise<Response>

  • Parameters

    • url: string
    • requestOptionsArgs: any

    Returns Promise<Response>

get

  • get(url: string, requestOptionsArgs: any): Promise<any>

  • Send a GET request to the specified url.

    Parameters

    • url: string
    • requestOptionsArgs: any

    Returns Promise<any>

getConnectionQuality

  • getConnectionQuality(): number

  • Get connection quality of the application indicated by values between [0, 100].

    Returns number

    A percentage of connection quality.

getName

  • getName(): string

  • Returns string

getRunningProcesses

  • getRunningProcesses(): any[]

  • Get underlying background process models of alive connections.

    Returns any[]

    Returns empty array if there is no alive connections.

getRunningProcessesCount

  • getRunningProcessesCount(): number

  • Get underlying background processes count of alive connections.

    Returns number

    Returns 0 if there is no alive connections.

getWithHttpInfo

  • getWithHttpInfo(url: string, requestOptionsArgs: any): Promise<Response>

  • Parameters

    • url: string
    • requestOptionsArgs: any

    Returns Promise<Response>

head

  • head(url: string, requestOptionsArgs: any): Promise<any>

  • Send HEAD request to the specified url.

    Parameters

    • url: string
    • requestOptionsArgs: any

    Returns Promise<any>

headWithHttpInfo

  • headWithHttpInfo(url: string, requestOptionsArgs: any): Promise<Response>

  • Parameters

    • url: string
    • requestOptionsArgs: any

    Returns Promise<Response>

options

  • options(url: string, requestOptionsArgs: any): Promise<any>

  • Send OPTIONS request to the specified url.

    Parameters

    • url: string
    • requestOptionsArgs: any

    Returns Promise<any>

optionsWithHttpInfo

  • optionsWithHttpInfo(url: string, requestOptionsArgs: any): Promise<Response>

  • Parameters

    • url: string
    • requestOptionsArgs: any

    Returns Promise<Response>

patch

  • patch(url: string, body: any, requestOptionsArgs: any): Promise<any>

  • Send PATCH request to the specified url.

    Parameters

    • url: string
    • body: any
    • requestOptionsArgs: any

    Returns Promise<any>

patchWithHttpInfo

  • patchWithHttpInfo(url: string, body: any, requestOptionsArgs: any): Promise<Response>

  • Parameters

    • url: string
    • body: any
    • requestOptionsArgs: any

    Returns Promise<Response>

post

  • post(url: string, body: any, requestOptionsArgs: any): Promise<any>

  • Send POST request to the specified url.

    Parameters

    • url: string
    • body: any
    • requestOptionsArgs: any

    Returns Promise<any>

postWithHttpInfo

  • postWithHttpInfo(url: string, body: any, requestOptionsArgs: any): Promise<Response>

  • Parameters

    • url: string
    • body: any
    • requestOptionsArgs: any

    Returns Promise<Response>

put

  • put(url: string, body: any, requestOptionsArgs: any): Promise<any>

  • Send PUT request to the specified url.

    Parameters

    • url: string
    • body: any
    • requestOptionsArgs: any

    Returns Promise<any>

putWithHttpInfo

  • putWithHttpInfo(url: string, body: any, requestOptionsArgs: any): Promise<Response>

  • Parameters

    • url: string
    • body: any
    • requestOptionsArgs: any

    Returns Promise<Response>

removeDefaultHeader

  • removeDefaultHeader(key: string): void

  • Parameters

    • key: string

    Returns void

removeParam

  • removeParam(key: string): void

  • Parameters

    • key: string

    Returns void

removeSearch

  • removeSearch(key: string): void

  • Parameters

    • key: string

    Returns void

request

  • request(url: string, requestOptionsArgs: any): Promise<any>

  • Parameters

    • url: string
    • requestOptionsArgs: any

    Returns Promise<any>

requestWithHttpInfo

  • requestWithHttpInfo(url: string, requestOptionsArgs: any): Promise<Response>

  • Parameters

    • url: string
    • requestOptionsArgs: any

    Returns Promise<Response>

resetBaseURLs

  • resetBaseURLs(): void

  • Returns void

resetDefaultHeaders

  • resetDefaultHeaders(): void

  • Returns void

resetParams

  • resetParams(): void

  • Returns void

resetSearch

  • resetSearch(): void

  • Returns void

setBaseURLs

  • setBaseURLs(urls: string[]): void

  • Parameters

    • urls: string[]

    Returns void

setDefaultHeader

  • setDefaultHeader(key: string, value: string): void

  • Parameters

    • key: string
    • value: string

    Returns void

setName

  • setName(name: string): any

  • Parameters

    • name: string

    Returns any

setParam

  • setParam(key: string, value: any): void

  • Parameters

    • key: string
    • value: any

    Returns void

setSearch

  • setSearch(key: string, value: any): void

  • Parameters

    • key: string
    • value: any

    Returns void

Generated using TypeDoc