API Docs for: 0.0.57
Show:

RegisteredServer Class

The information required to register a server with a discovery server.

Constructor

RegisteredServer

(
  • options
)

Parameters:

  • options Object
    • [serverUri] String optional

      The globally unique identifier for the server.

    • [productUri] String optional

      The globally unique identifier for the product.

    • [serverNames] LocalizedText[] optional

      The name of server in multiple lcoales.

    • [serverType] ApplicationType optional

      The type of server.

    • [gatewayServerUri] String optional

      The globally unique identifier for the server that is acting as a gateway for the server.

    • [discoveryUrls] String optional

      The URLs for the server's discovery endpoints.

    • [semaphoreFilePath] String optional

      A path to a file that is deleted when the server is no longer accepting connections.

    • [isOnline] Boolean optional

      If FALSE the server will save the registration information to a persistent datastore.

Methods

binaryStoreSize

() Number
Calculate the required size to store this object in a binary stream.

Returns:

Number:

decode_debug

()

encode

(
  • stream
)

encode the object into a binary stream

Parameters:

isValid

() Boolean
verify that all object attributes values are valid according to schema

Returns:

Boolean:

toString

() String

Returns:

String:

Properties

discoveryUrls

String

The URLs for the server's discovery endpoints.

gatewayServerUri

String

The globally unique identifier for the server that is acting as a gateway for the server.

isOnline

Boolean

If FALSE the server will save the registration information to a persistent datastore.

productUri

String

The globally unique identifier for the product.

semaphoreFilePath

String

A path to a file that is deleted when the server is no longer accepting connections.

serverNames

LocalizedText[]

The name of server in multiple lcoales.

serverType

ApplicationType

The type of server.

serverUri

String

The globally unique identifier for the server.