Class DdnsService

Hierarchy (View Summary)

Constructors

constructor

Properties

loggerService stateCron

Accessors

ExecutionFrequencySeconds ServiceName

Methods

getIPAddress getState isDdnsRequired job onModuleDestroy start stop

Constructors

constructor

Properties

ProtectedloggerService

loggerService: ConsoleLoggerService

ProtectedstateCron

stateCron: State = State.Stopped

Accessors

ExecutionFrequencySeconds

  • get ExecutionFrequencySeconds(): number

  • Fetches the execution frequency for the Ddns service from the configuration

    Returns number

ServiceName

  • get ServiceName(): string

  • ServiceName used in logging present in CronService

    Returns string

Methods

getIPAddress

  • getIPAddress(): undefined | string

  • NOTE! intentionally not a property as createMock behaves incorrectly

    Returns the current public IP Address. Will be undefined if not loaded

    Returns undefined | string

getState

  • getState(): State

  • NOTE! intentionally not a property as createMock behaves incorrectly

    Exposes the state of the cron service. Used to determine if it should be started as DDNS could be enabled at any time.

    Returns State

isDdnsRequired

  • isDdnsRequired(dnsEntries: DnsbaseEntry[]): boolean

  • Determines if any of the supplied entries are set to DDNS type. If so returns true, else false.

    Parameters

    Returns boolean

job

  • job(): Promise<void>

  • Fetches the current public IP address and updates the state. Will warn and leave ip unchanged if failure to fetch.

    Returns Promise<void>

onModuleDestroy

start

  • start(): Promise<void>

  • Starts the CRON Job executing. Will execute "synchronise" immediately on invocation and then every x seconds as distated by the environment variable EXECUTION_FREQUENCY_SECONDS.

    Returns Promise<void>

    Throws

    If service is already started

stop

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods