Class NetworkTablesTopic<T>

Type Parameters

T extends NetworkTablesTypes

Hierarchy

NetworkTablesTopic

Index

Constructors

constructor

new NetworkTablesTopic<T>(client, name, typeInfo, defaultValue?): NetworkTablesTopic<T>
Creates a new topic. This should only be done after the base NTCore client has been initialized.
Type Parameters
- T extends string | number | boolean | string[] | ArrayBuffer | boolean[] | number[]
Parameters
- client: PubSubClient
  The client that owns the topic.
- name: string
  The name of the topic.
- typeInfo: NetworkTablesTypeInfo
  The type info for the topic.
- Optional defaultValue: T
  The default value for the topic.
Returns NetworkTablesTopic<T>
- Defined in packages/ntcore-ts-client/src/lib/pubsub/topic.ts:105

Properties

`Private` _announced

_announced: boolean

`Private` `Optional` _id

_id?: number

`Private` `Optional` _lastChangedTime

_lastChangedTime?: number

`Private` `Readonly` _name

_name: string

`Private` _publisher

_publisher: boolean

`Private` `Optional` _pubuid

_pubuid?: number

`Private` _subscribers

_subscribers: Map<number, {
    callback: ((_) => void);
    immediateNotify: boolean;
    options: {
        all?: boolean;
        periodic?: number;
        prefix?: boolean;
        topicsonly?: boolean;
    };
}>

Type declaration

callback: ((_) => void)
- - (_): void
  - Parameters
    - _: null | T
    Returns void
immediateNotify: boolean
options: {
    all?: boolean;
    periodic?: number;
    prefix?: boolean;
    topicsonly?: boolean;
}
- Optional all?: boolean
- Optional periodic?: number
- Optional prefix?: boolean
- Optional topicsonly?: boolean

`Private` `Readonly` _typeInfo

_typeInfo: NetworkTablesTypeInfo

`Private` client

client: PubSubClient

`Private` value

value: null | T

Accessors

announced

get announced(): boolean
Whether the topic has been announced.

Returns boolean
Whether the topic has been announced.
- Defined in packages/ntcore-ts-client/src/lib/pubsub/topic.ts:69

id

get id(): undefined | number
Gets the ID of the topic.

Returns undefined | number
The ID of the topic.
- Defined in packages/ntcore-ts-client/src/lib/pubsub/topic.ts:37

lastChangedTime

get lastChangedTime(): undefined | number
Gets the server time of the last value change.

Returns undefined | number
The server time of the last value change.
- Defined in packages/ntcore-ts-client/src/lib/pubsub/topic.ts:61

name

get name(): string
Gets the name of the topic.

Returns string
The name of the topic.
- Defined in packages/ntcore-ts-client/src/lib/pubsub/topic.ts:45

publisher

get publisher(): boolean
Gets whether the client is the publisher of the topic.

Returns boolean
Whether the client is the publisher of the topic.
- Defined in packages/ntcore-ts-client/src/lib/pubsub/topic.ts:77

pubuid

get pubuid(): undefined | number
Gets the UID of the publisher.

Returns undefined | number
The UID of the publisher, or undefined if the client is not the publisher.
- Defined in packages/ntcore-ts-client/src/lib/pubsub/topic.ts:85

subscribers

get subscribers(): Map<number, {
    callback: ((_) => void);
    immediateNotify: boolean;
    options: {
        all?: boolean;
        periodic?: number;
        prefix?: boolean;
        topicsonly?: boolean;
    };
}>
Gets the subscribers to the topic.

Returns Map<number, {
    callback: ((_) => void);
    immediateNotify: boolean;
    options: {
        all?: boolean;
        periodic?: number;
        prefix?: boolean;
        topicsonly?: boolean;
    };
}>
The subscribers to the topic.
- Defined in packages/ntcore-ts-client/src/lib/pubsub/topic.ts:93

typeInfo

get typeInfo(): NetworkTablesTypeInfo
Gets the type info for the topic.

Returns NetworkTablesTypeInfo
The type info for the topic.
- Defined in packages/ntcore-ts-client/src/lib/pubsub/topic.ts:53

Methods

announce

announce(id): void
Marks the topic as announced. This should only be called by the PubSubClient.
Parameters
- id: number
  The ID of the topic.
Returns void
- Defined in packages/ntcore-ts-client/src/lib/pubsub/topic.ts:164

getValue

getValue(): null | T
Returns null | T
- Defined in packages/ntcore-ts-client/src/lib/pubsub/topic.ts:140

`Private` notifySubscribers

notifySubscribers(): void
Notifies all subscribers of the current value.

Returns void
- Defined in packages/ntcore-ts-client/src/lib/pubsub/topic.ts:242

publish

publish(properties?, id?): void
Publishes the topic.
Parameters
- properties: {
  persistent?: boolean;
  retained?: boolean;
  } = {}
  The properties to publish the topic with.
  - Optional persistent?: boolean
  - Optional retained?: boolean
- Optional id: number
  The UID of the publisher.
Returns void
- Defined in packages/ntcore-ts-client/src/lib/pubsub/topic.ts:255

republish

republish(client): void
Republishes the topic.
Parameters
- client: PubSubClient
  The client to republish with.
Returns void
- Defined in packages/ntcore-ts-client/src/lib/pubsub/topic.ts:288

resubscribeAll

resubscribeAll(client): void
Resubscribes all local subscribers.
Parameters
- client: PubSubClient
  The client to resubscribe with.
Returns void
- Defined in packages/ntcore-ts-client/src/lib/pubsub/topic.ts:232

setProperties

setProperties(persistent?, retained?): void
Sets the properties of the topic.
Parameters
- Optional persistent: boolean
  If true, the last set value will be periodically saved to persistent storage on the server and be restored during server startup. Topics with this property set to true will not be deleted by the server when the last publisher stops publishing.
- Optional retained: boolean
  Topics with this property set to true will not be deleted by the server when the last publisher stops publishing.
Returns void
- Defined in packages/ntcore-ts-client/src/lib/pubsub/topic.ts:302

setValue

setValue(value): void
Sets the value of the topic. The client must be the publisher of the topic to set the value.
Parameters
- value: T
  The value to set.
Returns void
- Defined in packages/ntcore-ts-client/src/lib/pubsub/topic.ts:131

subscribe(callback, immediateNotify?, options?, id?, save?): number
Creates a new subscriber. This should only be called by the PubSubClient.
Parameters
- callback: ((_) => void)
  The callback to call when the topic value changes.
  - - (_): void
    - Parameters
      _: null | T
      Returns void
- immediateNotify: boolean = false
  Whether to immediately notify the subscriber of the current value.
- options: {
      all?: boolean;
      periodic?: number;
      prefix?: boolean;
      topicsonly?: boolean;
  } = {}
  The options for the subscriber.
  - Optional all?: boolean
  - Optional periodic?: number
  - Optional prefix?: boolean
  - Optional topicsonly?: boolean
- Optional id: number
  The UID of the subscriber.
- save: boolean = true
  Whether to save the subscriber.
Returns number
The UID of the subscriber.
- Defined in packages/ntcore-ts-client/src/lib/pubsub/topic.ts:188

unannounce

unannounce(): void
Marks the topic as unannounced. This should only be called by the PubSubClient.

Returns void
- Defined in packages/ntcore-ts-client/src/lib/pubsub/topic.ts:170

unpublish

unpublish(): void
Unpublishes the topic.

Returns void
- Defined in packages/ntcore-ts-client/src/lib/pubsub/topic.ts:273

unsubscribe

unsubscribe(subuid, removeCallback?): void
Removes a subscriber
Parameters
- subuid: number
  The UID of the subscriber.
- removeCallback: boolean = true
  Whether to remove the callback. Leave this as true unless you know what you're doing.
Returns void
- Defined in packages/ntcore-ts-client/src/lib/pubsub/topic.ts:216

unsubscribeAll

unsubscribeAll(): void
Removes all local subscribers.

Returns void
- Defined in packages/ntcore-ts-client/src/lib/pubsub/topic.ts:224

updateValue

updateValue(value, lastChangedTime): void
Updates the value of the topic. This should only be called by the PubSubClient.
Parameters
- value: T
  The value to update.
- lastChangedTime: number
  The server time of the last value change.
Returns void
- Defined in packages/ntcore-ts-client/src/lib/pubsub/topic.ts:150

Class NetworkTablesTopic<T>

Type Parameters

T extends NetworkTablesTypes

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T extends string | number | boolean | string[] | ArrayBuffer | boolean[] | number[]

Parameters

client: PubSubClient

name: string

typeInfo: NetworkTablesTypeInfo

Optional defaultValue: T

Returns NetworkTablesTopic<T>

Properties

Private _announced

Private Optional _id

Private Optional _lastChangedTime

Private Readonly _name

Private _publisher

Private Optional _pubuid

Private _subscribers

Type declaration

callback: ((_) => void)

Parameters

_: null | T

Returns void

immediateNotify: boolean

options: { all?: boolean; periodic?: number; prefix?: boolean; topicsonly?: boolean; }

Optional all?: boolean

Optional periodic?: number

Optional prefix?: boolean

Optional topicsonly?: boolean

Private Readonly _typeInfo

Private client

Private value

Accessors

announced

Returns boolean

id

Returns undefined | number

lastChangedTime

Returns undefined | number

name

Returns string

publisher

Returns boolean

pubuid

Returns undefined | number

subscribers

Returns Map<number, { callback: ((_) => void); immediateNotify: boolean; options: { all?: boolean; periodic?: number; prefix?: boolean; topicsonly?: boolean; }; }>

typeInfo

Returns NetworkTablesTypeInfo

Methods

announce

Parameters

id: number

Returns void

getValue

Returns null | T

Private notifySubscribers

Returns void

publish

Parameters

properties: { persistent?: boolean; retained?: boolean; } = {}

Optional persistent?: boolean

Optional retained?: boolean

Optional id: number

Returns void

republish

Parameters

client: PubSubClient

Returns void

resubscribeAll

Parameters

`Optional` defaultValue: T

`Private` _announced

`Private` `Optional` _id

`Private` `Optional` _lastChangedTime

`Private` `Readonly` _name

`Private` _publisher

`Private` `Optional` _pubuid

`Private` _subscribers

options: {
all?: boolean;
periodic?: number;
prefix?: boolean;
topicsonly?: boolean;
}

`Optional` all?: boolean

`Optional` periodic?: number

`Optional` prefix?: boolean

`Optional` topicsonly?: boolean

`Private` `Readonly` _typeInfo

`Private` client

`Private` value

Returns Map<number, {
callback: ((_) => void);
immediateNotify: boolean;
options: {
all?: boolean;
periodic?: number;
prefix?: boolean;
topicsonly?: boolean;
};
}>

`Private` notifySubscribers

properties: {
persistent?: boolean;
retained?: boolean;
} = {}

`Optional` persistent?: boolean

`Optional` retained?: boolean

`Optional` id: number

`Optional` persistent: boolean

`Optional` retained: boolean

options: {
all?: boolean;
periodic?: number;
prefix?: boolean;
topicsonly?: boolean;
} = {}

`Optional` all?: boolean

`Optional` periodic?: number

`Optional` prefix?: boolean

`Optional` topicsonly?: boolean

`Optional` id: number