org.wpilib.telemetry.TelemetryBackend Interface Reference

Inheritance diagram for org.wpilib.telemetry.TelemetryBackend:

Public Member Functions
TelemetryEntry	getEntry (String path)
default boolean	ownsBackend (TelemetryBackend backend)
default boolean	sharesBackendWith (TelemetryBackend backend)
default void	removeEntry (String path)

Detailed Description

Interface for telemetry backends.

Implementations registered with TelemetryRegistry must be thread-safe. Backend and entry methods may be called concurrently, and entry removal or backend closure may overlap a call already in progress on a previously returned entry.

Definition at line 14 of file TelemetryBackend.java.

Member Function Documentation

getEntry()

TelemetryEntry org.wpilib.telemetry.TelemetryBackend.getEntry

(

String

path

)

Create an entry for the given path.

Backend implementations must not throw from this method. Recoverable failures should be reported through TelemetryRegistry#reportWarning(String, String) and represented with a discard entry.

Parameters

path

full name

Returns

telemetry entry

Implemented in org.wpilib.backend.NetworkTablesTelemetryBackend, org.wpilib.telemetry.DiscardTelemetryBackend, and org.wpilib.telemetry.MultiTelemetryBackend.

ownsBackend()

default boolean org.wpilib.telemetry.TelemetryBackend.ownsBackend

(

TelemetryBackend

backend

)

Returns whether this backend is or owns the given backend instance for lifecycle purposes.

Composite backends should override this and recursively check child backends that are closed when this backend is closed. The registry uses this to avoid closing a displaced backend that is now retained by another registered backend.

Parameters

backend

backend instance

Returns

True if this backend is or owns the given backend

Implemented in org.wpilib.telemetry.MultiTelemetryBackend.

Definition at line 38 of file TelemetryBackend.java.

removeEntry()

default void org.wpilib.telemetry.TelemetryBackend.removeEntry

(

String

path

)

Removes an entry for the given path.

Backend implementations must not throw from this method.

Parameters

path	normalized full name

Implemented in org.wpilib.telemetry.MultiTelemetryBackend.

Definition at line 63 of file TelemetryBackend.java.

sharesBackendWith()

default boolean org.wpilib.telemetry.TelemetryBackend.sharesBackendWith

(

TelemetryBackend

backend

)

Returns whether this backend shares lifecycle ownership with another backend.

The registry uses this to avoid closing displaced backends whose close operation would close a backend that remains registered elsewhere.

Parameters

backend

backend instance

Returns

True if this backend owns, is owned by, or shares a child backend with the given backend

Implemented in org.wpilib.telemetry.MultiTelemetryBackend.

Definition at line 52 of file TelemetryBackend.java.

---

The documentation for this interface was generated from the following file:

• org/wpilib/telemetry/TelemetryBackend.java