Connection | telnet-rxjs

Hierarchy

ReplaySubject<Event>
- Connection

Implements

Subscribable<Event>
SubscriptionLike

Index

Properties

Accessors

Type aliases

Static StateType

StateType: "DISCONNECTED" | "DISCONNECTING" | "CONNECTING" | "CONNECTED"

Constructors

constructor

new Connection(options?: IOptions): Connection

Overrides ReplaySubject.__constructor
- Defined in src/connection.ts:20
Parameters
- Default value options: IOptions = {}
Returns Connection

Properties

Private PrivateSocket

PrivateSocket: TLSSocket | Socket

_isScalar

_isScalar: boolean

Internal implementation detail, do not use directly.

closed

closed: boolean

filter

filter: typeof filter

hasError

hasError: boolean

isStopped

isStopped: boolean

observers

observers: Observer<Event>[]

operator

operator: Operator<any, Event>

deprecated: This is an internal implementation detail, do not use.

Private options

options: IOptions

source

source: Observable<any>

deprecated: This is an internal implementation detail, do not use.

Private state

state: State = Connection.State.Disconnected

thrownError

thrownError: any

Static Readonly DEFAULT_ENCODING

DEFAULT_ENCODING: "utf8" = "utf8"

Static Readonly EOL

EOL: "" = ""

Static create

create: Function

nocollapse
deprecated: use new Subject() instead

Static if

if: typeof iif

nocollapse
deprecated: In favor of iif creation function: import { iif } from 'rxjs';

Static throw

throw: typeof throwError

nocollapse
deprecated: In favor of throwError creation function: import { throwError } from 'rxjs';

Accessors

commands

get commands(): Observable<number[]>

- Defined in src/connection.ts:50
An observable that tracks any telnet commands sent to the client

Returns Observable<number[]>

connected

get connected(): boolean

- Defined in src/connection.ts:152
Return whether the underlying socket is connected

Returns boolean

data

get data(): Observable<string>

- Defined in src/connection.ts:42
An observable that tracks the data being sent to the client

Returns Observable<string>

socket

get socket(): TLSSocket | Socket

- Defined in src/connection.ts:35
Returns TLSSocket | Socket

Methods

_getNow

_getNow(): number

Inherited from Connection._getNow
- Defined in node_modules/rxjs/internal/ReplaySubject.d.ts:23
Returns number

_subscribe

_subscribe(subscriber: Subscriber<Event>): Subscription

Inherited from Connection._subscribe

Overrides Subject._subscribe
- Defined in node_modules/rxjs/internal/ReplaySubject.d.ts:22
deprecated

This is an internal implementation detail, do not use.

Parameters
- subscriber: Subscriber<Event>
Returns Subscription

_trySubscribe

_trySubscribe(subscriber: Subscriber<Event>): TeardownLogic

Inherited from Connection._trySubscribe

Overrides Observable._trySubscribe
- Defined in node_modules/rxjs/internal/Subject.d.ts:39
deprecated

This is an internal implementation detail, do not use.

Parameters
- subscriber: Subscriber<Event>
Returns TeardownLogic

asObservable

asObservable(): Observable<Event>

Inherited from Connection.asObservable
- Defined in node_modules/rxjs/internal/Subject.d.ts:48
Creates a new Observable with this Subject as the source. You can do this to create customize Observer-side logic of the Subject and conceal it from code that uses the Observable.

Returns Observable<Event>

Observable that the Subject casts to

complete

complete(): void

Inherited from Connection.complete
- Defined in node_modules/rxjs/internal/Subject.d.ts:36
Returns void

connect

connect(): TLSSocket | Socket

- Defined in src/connection.ts:82
Connects to the server URI that was passed in with the constructor

throws

an error if the client cannot connect

Returns TLSSocket | Socket

Private connectNoTls

connectNoTls(hostUrl: Url): Socket

- Defined in src/connection.ts:191
Parameters
- hostUrl: Url
Returns Socket

Private connectTls

connectTls(hostUrl: Url): TLSSocket

- Defined in src/connection.ts:201
Parameters
- hostUrl: Url
Returns TLSSocket

disconnect

disconnect(): void

- Defined in src/connection.ts:140
Close the telnet connection

Returns void

error

error(err: any): void

Inherited from Connection.error
- Defined in node_modules/rxjs/internal/Subject.d.ts:35
Parameters
- err: any
Returns void

forEach

forEach(next: (value: Event) => void, promiseCtor?: PromiseConstructorLike): Promise<void>

Inherited from Connection.forEach
- Defined in node_modules/rxjs/internal/Observable.d.ts:64
method

forEach

Parameters
- next: (value: Event) => void
  
  a handler for each value emitted by the observable
  - - (value: Event): void
    - Parameters
      - value: Event
      Returns void
- Optional promiseCtor: PromiseConstructorLike
Returns Promise<void>

a promise that either resolves on observable completion or rejects with the handled error

Private handleTelnetCommand

handleTelnetCommand(data: number[], position: number): number

- Defined in src/connection.ts:165
Processes in-band telnet commands. Please see the relevant RFCs for more information. Commands are published to the connetion observable as Event.Command and can be responded to by filtering for this information.

Parameters
- data: number[]
  
  the array of data for the current input
- position: number
  
  the current position of the data cursor
Returns number

the new position of the data cursor

lift

lift<R>(operator: Operator<Event, R>): Observable<R>

Inherited from Connection.lift

Overrides Observable.lift
- Defined in node_modules/rxjs/internal/Subject.d.ts:33
Type parameters
- R
Parameters
- operator: Operator<Event, R>
Returns Observable<R>

next(value?: T): void

Inherited from Connection.next
- Defined in node_modules/rxjs/internal/Subject.d.ts:34
Parameters
- Optional value: T
Returns void

pipe

pipe(): Observable<Event>
pipe<A>(op1: OperatorFunction<Event, A>): Observable<A>
pipe<A, B>(op1: OperatorFunction<Event, A>, op2: OperatorFunction<A, B>): Observable<B>
pipe<A, B, C>(op1: OperatorFunction<Event, A>, op2: OperatorFunction<A, B>, op3: OperatorFunction<B, C>): Observable<C>
pipe<A, B, C, D>(op1: OperatorFunction<Event, A>, op2: OperatorFunction<A, B>, op3: OperatorFunction<B, C>, op4: OperatorFunction<C, D>): Observable<D>
pipe<A, B, C, D, E>(op1: OperatorFunction<Event, A>, op2: OperatorFunction<A, B>, op3: OperatorFunction<B, C>, op4: OperatorFunction<C, D>, op5: OperatorFunction<D, E>): Observable<E>
pipe<A, B, C, D, E, F>(op1: OperatorFunction<Event, A>, op2: OperatorFunction<A, B>, op3: OperatorFunction<B, C>, op4: OperatorFunction<C, D>, op5: OperatorFunction<D, E>, op6: OperatorFunction<E, F>): Observable<F>
pipe<A, B, C, D, E, F, G>(op1: OperatorFunction<Event, A>, op2: OperatorFunction<A, B>, op3: OperatorFunction<B, C>, op4: OperatorFunction<C, D>, op5: OperatorFunction<D, E>, op6: OperatorFunction<E, F>, op7: OperatorFunction<F, G>): Observable<G>
pipe<A, B, C, D, E, F, G, H>(op1: OperatorFunction<Event, A>, op2: OperatorFunction<A, B>, op3: OperatorFunction<B, C>, op4: OperatorFunction<C, D>, op5: OperatorFunction<D, E>, op6: OperatorFunction<E, F>, op7: OperatorFunction<F, G>, op8: OperatorFunction<G, H>): Observable<H>
pipe<A, B, C, D, E, F, G, H, I>(op1: OperatorFunction<Event, A>, op2: OperatorFunction<A, B>, op3: OperatorFunction<B, C>, op4: OperatorFunction<C, D>, op5: OperatorFunction<D, E>, op6: OperatorFunction<E, F>, op7: OperatorFunction<F, G>, op8: OperatorFunction<G, H>, op9: OperatorFunction<H, I>): Observable<I>
pipe<A, B, C, D, E, F, G, H, I>(op1: OperatorFunction<Event, A>, op2: OperatorFunction<A, B>, op3: OperatorFunction<B, C>, op4: OperatorFunction<C, D>, op5: OperatorFunction<D, E>, op6: OperatorFunction<E, F>, op7: OperatorFunction<F, G>, op8: OperatorFunction<G, H>, op9: OperatorFunction<H, I>, ...operations: OperatorFunction<any, any>[]): Observable<{}>

Inherited from Connection.pipe
- Defined in node_modules/rxjs/internal/Observable.d.ts:77
Returns Observable<Event>
Inherited from Connection.pipe
- Defined in node_modules/rxjs/internal/Observable.d.ts:78
Type parameters
- A
Parameters
- op1: OperatorFunction<Event, A>
Returns Observable<A>
Inherited from Connection.pipe
- Defined in node_modules/rxjs/internal/Observable.d.ts:79
Type parameters
- A
- B
Parameters
- op1: OperatorFunction<Event, A>
- op2: OperatorFunction<A, B>
Returns Observable<B>
Inherited from Connection.pipe
- Defined in node_modules/rxjs/internal/Observable.d.ts:80
Type parameters
- A
- B
- C
Parameters
- op1: OperatorFunction<Event, A>
- op2: OperatorFunction<A, B>
- op3: OperatorFunction<B, C>
Returns Observable<C>
Inherited from Connection.pipe
- Defined in node_modules/rxjs/internal/Observable.d.ts:81
Type parameters
- A
- B
- C
- D
Parameters
- op1: OperatorFunction<Event, A>
- op2: OperatorFunction<A, B>
- op3: OperatorFunction<B, C>
- op4: OperatorFunction<C, D>
Returns Observable<D>
Inherited from Connection.pipe
- Defined in node_modules/rxjs/internal/Observable.d.ts:82
Type parameters
- A
- B
- C
- D
- E
Parameters
- op1: OperatorFunction<Event, A>
- op2: OperatorFunction<A, B>
- op3: OperatorFunction<B, C>
- op4: OperatorFunction<C, D>
- op5: OperatorFunction<D, E>
Returns Observable<E>
Inherited from Connection.pipe
- Defined in node_modules/rxjs/internal/Observable.d.ts:83
Type parameters
- A
- B
- C
- D
- E
- F
Parameters
- op1: OperatorFunction<Event, A>
- op2: OperatorFunction<A, B>
- op3: OperatorFunction<B, C>
- op4: OperatorFunction<C, D>
- op5: OperatorFunction<D, E>
- op6: OperatorFunction<E, F>
Returns Observable<F>
Inherited from Connection.pipe
- Defined in node_modules/rxjs/internal/Observable.d.ts:84
Type parameters
- A
- B
- C
- D
- E
- F
- G
Parameters
- op1: OperatorFunction<Event, A>
- op2: OperatorFunction<A, B>
- op3: OperatorFunction<B, C>
- op4: OperatorFunction<C, D>
- op5: OperatorFunction<D, E>
- op6: OperatorFunction<E, F>
- op7: OperatorFunction<F, G>
Returns Observable<G>
Inherited from Connection.pipe
- Defined in node_modules/rxjs/internal/Observable.d.ts:85
Type parameters
- A
- B
- C
- D
- E
- F
- G
- H
Parameters
- op1: OperatorFunction<Event, A>
- op2: OperatorFunction<A, B>
- op3: OperatorFunction<B, C>
- op4: OperatorFunction<C, D>
- op5: OperatorFunction<D, E>
- op6: OperatorFunction<E, F>
- op7: OperatorFunction<F, G>
- op8: OperatorFunction<G, H>
Returns Observable<H>
Inherited from Connection.pipe
- Defined in node_modules/rxjs/internal/Observable.d.ts:86
Type parameters
- A
- B
- C
- D
- E
- F
- G
- H
- I
Parameters
- op1: OperatorFunction<Event, A>
- op2: OperatorFunction<A, B>
- op3: OperatorFunction<B, C>
- op4: OperatorFunction<C, D>
- op5: OperatorFunction<D, E>
- op6: OperatorFunction<E, F>
- op7: OperatorFunction<F, G>
- op8: OperatorFunction<G, H>
- op9: OperatorFunction<H, I>
Returns Observable<I>
Inherited from Connection.pipe
- Defined in node_modules/rxjs/internal/Observable.d.ts:87
Type parameters
- A
- B
- C
- D
- E
- F
- G
- H
- I
Parameters
- op1: OperatorFunction<Event, A>
- op2: OperatorFunction<A, B>
- op3: OperatorFunction<B, C>
- op4: OperatorFunction<C, D>
- op5: OperatorFunction<D, E>
- op6: OperatorFunction<E, F>
- op7: OperatorFunction<F, G>
- op8: OperatorFunction<G, H>
- op9: OperatorFunction<H, I>
- Rest ...operations: OperatorFunction<any, any>[]
Returns Observable<{}>

send

send(data: string): void

- Defined in src/connection.ts:60
Sends the given string to the server.

Parameters
- data: string
  
  the string to send to the server
Returns void

Private sendConnected

sendConnected(): void

- Defined in src/connection.ts:226
Returns void

Private sendConnecting

sendConnecting(): void

- Defined in src/connection.ts:221
Returns void

Private sendDisconnected

sendDisconnected(): void

- Defined in src/connection.ts:216
Returns void

Private sendDisconnecting

sendDisconnecting(): void

- Defined in src/connection.ts:211
Returns void

sendln

sendln(data: string): void

- Defined in src/connection.ts:73
Sends the given string to the server and then sends an EOL ("\r\n").

Parameters
- data: string
  
  the string to send to the server
Returns void

subscribe(observer?: PartialObserver<Event>): Subscription
subscribe(next: null | undefined, error: null | undefined, complete: () => void): Subscription
subscribe(next: null | undefined, error: (error: any) => void, complete?: undefined | (() => void)): Subscription
subscribe(next: (value: Event) => void, error: null | undefined, complete: () => void): Subscription
subscribe(next?: undefined | ((value: Event) => void), error?: undefined | ((error: any) => void), complete?: undefined | (() => void)): Subscription

Inherited from Connection.subscribe
- Defined in node_modules/rxjs/internal/Observable.d.ts:47
Parameters
- Optional observer: PartialObserver<Event>
Returns Subscription
Inherited from Connection.subscribe
- Defined in node_modules/rxjs/internal/Observable.d.ts:49
deprecated

Use an observer instead of a complete callback

Parameters
- next: null | undefined
- error: null | undefined
- complete: () => void
  - - (): void
    - Returns void
Returns Subscription
Inherited from Connection.subscribe
- Defined in node_modules/rxjs/internal/Observable.d.ts:51
deprecated

Use an observer instead of an error callback

Parameters
- next: null | undefined
- error: (error: any) => void
  - - (error: any): void
    - Parameters
      - error: any
      Returns void
- Optional complete: undefined | (() => void)
Returns Subscription
Inherited from Connection.subscribe
- Defined in node_modules/rxjs/internal/Observable.d.ts:53
deprecated

Use an observer instead of a complete callback

Parameters
- next: (value: Event) => void
  - - (value: Event): void
    - Parameters
      - value: Event
      Returns void
- error: null | undefined
- complete: () => void
  - - (): void
    - Returns void
Returns Subscription
Inherited from Connection.subscribe
- Defined in node_modules/rxjs/internal/Observable.d.ts:54
Parameters
- Optional next: undefined | ((value: Event) => void)
- Optional error: undefined | ((error: any) => void)
- Optional complete: undefined | (() => void)
Returns Subscription

toPromise

toPromise<T>(this: Observable<T>): Promise<T>
toPromise<T>(this: Observable<T>, PromiseCtor: typeof Promise): Promise<T>
toPromise<T>(this: Observable<T>, PromiseCtor: PromiseConstructorLike): Promise<T>

Inherited from Connection.toPromise
- Defined in node_modules/rxjs/internal/Observable.d.ts:88
Type parameters
- T
Parameters
- this: Observable<T>
Returns Promise<T>
Inherited from Connection.toPromise
- Defined in node_modules/rxjs/internal/Observable.d.ts:89
Type parameters
- T
Parameters
- this: Observable<T>
- PromiseCtor: typeof Promise
Returns Promise<T>
Inherited from Connection.toPromise
- Defined in node_modules/rxjs/internal/Observable.d.ts:90
Type parameters
- T
Parameters
- this: Observable<T>
- PromiseCtor: PromiseConstructorLike
Returns Promise<T>

unsubscribe

unsubscribe(): void

Inherited from Connection.unsubscribe
- Defined in node_modules/rxjs/internal/Subject.d.ts:37
Returns void

Hierarchy

Implements

Index

Classes

Interfaces

Type aliases

Constructors

Properties

Accessors

Methods

Type aliases

Static StateType

Constructors

constructor

Parameters

Default value options: IOptions = {}

Returns Connection

Properties

Private PrivateSocket

_isScalar

closed

filter

hasError

isStopped

observers

operator

Private options

source

Private state

thrownError

Static Readonly DEFAULT_ENCODING

Static Readonly EOL

Static create

Static if

Static throw

Accessors

commands

Returns Observable<number[]>

connected

Returns boolean

data

Returns Observable<string>

socket

Returns TLSSocket | Socket

Methods

_getNow

Returns number

_subscribe

Parameters

subscriber: Subscriber<Event>

Returns Subscription

_trySubscribe

Parameters

subscriber: Subscriber<Event>

Returns TeardownLogic

asObservable

Returns Observable<Event>

complete

Returns void

connect

Returns TLSSocket | Socket

Private connectNoTls

Parameters

hostUrl: Url

Returns Socket

Private connectTls

Parameters

hostUrl: Url

Returns TLSSocket

disconnect

Returns void

error

Parameters

err: any

Returns void

forEach

Parameters

next: (value: Event) => void

Parameters

value: Event