Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SimpleSocket

A "simple" socket.

Hierarchy

  • EventEmitter
    • SimpleSocket

Index

Constructors

constructor

  • Initializes a new instance of that class.

    Parameters

    • type: SocketType

      The type.

    • Optional socket: Socket

    Returns SimpleSocket

Properties

Protected _socket

_socket: Socket

Stores the wrapped socket.

Protected _type

_type: SocketType

Stores the type.

compress

compress: boolean = Compress

Try compress data or not.

cwd

cwd: string = DefaultCWD

The path of the working directory.

dataTransformer

dataTransformer: function = DefaultDataTransformer

A custom function that transformes data before it is send or after it has been received.

encoding

encoding: string = DefaultEncoding

Gets or sets the (string) encoding to use.

handshakeTransformer

handshakeTransformer: function = DefaultHandshakeTransformer

A custom function that transforms the handshake public key before it is send or after it has been received.

maxPackageSize

maxPackageSize: number = DefaultMaxPackageSize

Defines the maximum size of a package.

password

password: Buffer

Stores the current password.

passwordGenerator

passwordGenerator: function = DefaultPasswordGenerator

Defines a custom logic to generate a password (for the connection).

Type declaration

readBufferSize

readBufferSize: number = DefaultReadBufferSize

The default buffer size for reading a stream.

rsaKeySize

rsaKeySize: number = DefaultRSAKeySize

The RSA key size.

Static defaultMaxListeners

defaultMaxListeners: number

Accessors

algorithm

  • get algorithm(): string
  • Gets the symetric encryption algorithm.

    Returns string

socket

  • get socket(): Socket
  • Gets the wrapped socket.

    Returns Socket

    The wrapped socket.

type

  • Gets the socket type.

    Returns SocketType

Methods

addListener

  • addListener(event: string | symbol, listener: Function)
  • Parameters

    • event: string | symbol
    • listener: Function

dispose

  • dispose(): void
  • Disposes the socket.

    Returns void

emit

  • emit(event: string | symbol, ...args: any[]): boolean
  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

end

  • end(data?: any, encoding?: string): Promise<any>
  • Sends the connection.

    Parameters

    • Optional data: any
    • Optional encoding: string

    Returns Promise<any>

    The promise.

eventNames

  • eventNames(): string | symbol
  • Returns string | symbol

Protected generatePassword

  • generatePassword(): Promise<Buffer>
  • Generates a password based on the 'passwordGenerator' property.

    Returns Promise<Buffer>

Protected getCwd

  • getCwd(): string
  • Returns the working directory.

    Returns string

    The working directory.

Protected getEncoding

  • getEncoding(): string
  • Returns the (string) encoding that should be used by that socket.

    Returns string

    The encoding.

getMaxListeners

  • getMaxListeners(): number
  • Returns number

getMaxPackageSize

  • getMaxPackageSize(): number
  • Gets the maximum size for a package.

    Returns number

    The maximum package size.

Protected getRSAKeySize

  • getRSAKeySize(): number
  • Gets the size for a RSA key.

    Returns number

    The RSA key size.

Protected getReadBufferSize

  • getReadBufferSize(): number
  • Returns the buffer size for reading streams.

    Returns number

    The buffer size.

listenerCount

  • listenerCount(type: string | symbol): number
  • Parameters

    • type: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]
  • Parameters

    • event: string | symbol

    Returns Function[]

Protected makeClientHandshake

  • makeClientHandshake(): Promise<Buffer>
  • Makes a CLIENT handshake.

    Returns Promise<Buffer>

makeHandshakeIfNeeded

  • makeHandshakeIfNeeded(): Promise<Buffer>
  • Makes a handshake if needed.

    Returns Promise<Buffer>

Protected makeServerHandshake

  • makeServerHandshake(): Promise<Buffer>
  • Makes a SERVER handshake.

    Returns Promise<Buffer>

on

  • on(event: string | symbol, listener: Function)
  • Parameters

    • event: string | symbol
    • listener: Function

once

  • once(event: string | symbol, listener: Function)
  • Parameters

    • event: string | symbol
    • listener: Function

prependListener

  • prependListener(event: string | symbol, listener: Function)
  • Parameters

    • event: string | symbol
    • listener: Function

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: Function)
  • Parameters

    • event: string | symbol
    • listener: Function

read

  • read(): Promise<Buffer>
  • Reads data from the remote.

    Returns Promise<Buffer>

readFile

  • readFile(path: string, flags?: string | number): Promise<number>
  • Reads data from remote and writes it to a file on this machine.

    Parameters

    • path: string

      The path to the target file.

    • Default value flags: string | number = "w"

    Returns Promise<number>

    The promise.

readJSON

  • readJSON<T>(): Promise<T>
  • Reads data as JSON object.

    Type parameters

    • T

    Returns Promise<T>

    The promise.

readStream

  • readStream(fdTarget: number): Promise<number>
  • Reads data from remote and writes it to a stream on this machine.

    Parameters

    • fdTarget: number

      The stream pointer of the target.

    Returns Promise<number>

    The promise.

readString

  • readString(): Promise<string>
  • Reads data as string.

    Returns Promise<string>

    The promise.

removeAllListeners

  • removeAllListeners(event?: string | symbol)
  • Parameters

    • Optional event: string | symbol

removeListener

  • removeListener(event: string | symbol, listener: Function)
  • Parameters

    • event: string | symbol
    • listener: Function

setMaxListeners

  • setMaxListeners(n: number)
  • Parameters

    • n: number

Protected setupEvents

  • setupEvents(): void
  • Sets up the events.

    Returns void

Protected tryCompress

  • Tries to compress data.

    Parameters

    • data: any

      The data to compress.

    Returns Promise<CompressionResult>

    The promise.

write

  • write(data: any): Promise<Buffer>
  • Reads data from the remote.

    Parameters

    • data: any

    Returns Promise<Buffer>

writeFile

  • writeFile(path: string, maxSize?: number, bufferSize?: number, flags?: string | number): Promise<number>
  • Sends the data of a file to the remote.

    Parameters

    • path: string

      The path of the file to send.

    • Optional maxSize: number
    • Optional bufferSize: number
    • Default value flags: string | number = "r"

    Returns Promise<number>

    The promise.

writeJSON

  • writeJSON<T>(obj: T): Promise<Buffer>
  • Sends an object / value as JSON string.

    Type parameters

    • T

    Parameters

    • obj: T

      The object to send.

    Returns Promise<Buffer>

    The promise.

writeStream

  • writeStream(fdSrc: number, maxSize?: number, bufferSize?: number): Promise<number>
  • Sends the data of a stream to the remote.

    Parameters

    • fdSrc: number

      The stream pointer from where to read.

    • Optional maxSize: number
    • Optional bufferSize: number

    Returns Promise<number>

    The promise.

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc