WPILibC++ 2024.3.1
ntcore C API

Handle-based interface for C. More...

Modules

 Instance Functions
 
 Table Functions
 
 Topic Functions
 
 Advanced Subscriber Functions
 
 Listener Functions
 
 Client/Server Functions
 
 Utility Functions
 
 Data Logger Functions
 
 Logger Functions
 
 Schema Functions
 
 Interop Utility Functions
 
 Boolean Functions
 
 Integer Functions
 
 Float Functions
 
 Double Functions
 
 String Functions
 
 Raw Functions
 
 BooleanArray Functions
 
 IntegerArray Functions
 
 FloatArray Functions
 
 DoubleArray Functions
 
 StringArray Functions
 

Classes

struct  NT_String
 A NetworkTables string. More...
 
struct  NT_Value
 NetworkTables Entry Value. More...
 
struct  NT_TopicInfo
 NetworkTables Topic Information. More...
 
struct  NT_ConnectionInfo
 NetworkTables Connection Information. More...
 
struct  NT_ValueEventData
 NetworkTables value event data. More...
 
struct  NT_LogMessage
 NetworkTables log message. More...
 
struct  NT_TimeSyncEventData
 NetworkTables time sync event data. More...
 
struct  NT_Event
 NetworkTables event. More...
 
struct  NT_PubSubOptions
 NetworkTables publish/subscribe options. More...
 
struct  NT_TimestampedBoolean
 Timestamped Boolean. More...
 
struct  NT_TimestampedInteger
 Timestamped Integer. More...
 
struct  NT_TimestampedFloat
 Timestamped Float. More...
 
struct  NT_TimestampedDouble
 Timestamped Double. More...
 
struct  NT_TimestampedString
 Timestamped String. More...
 
struct  NT_TimestampedRaw
 Timestamped Raw. More...
 
struct  NT_TimestampedBooleanArray
 Timestamped BooleanArray. More...
 
struct  NT_TimestampedIntegerArray
 Timestamped IntegerArray. More...
 
struct  NT_TimestampedFloatArray
 Timestamped FloatArray. More...
 
struct  NT_TimestampedDoubleArray
 Timestamped DoubleArray. More...
 
struct  NT_TimestampedStringArray
 Timestamped StringArray. More...
 

Macros

#define NT_DEFAULT_PORT3   1735
 Default network tables port number (NT3) More...
 
#define NT_DEFAULT_PORT4   5810
 Default network tables port number (NT4) More...
 

Typedefs

typedef int NT_Bool
 Typedefs. More...
 
typedef unsigned int NT_Handle
 
typedef NT_Handle NT_ConnectionDataLogger
 
typedef NT_Handle NT_DataLogger
 
typedef NT_Handle NT_Entry
 
typedef NT_Handle NT_Inst
 
typedef NT_Handle NT_Listener
 
typedef NT_Handle NT_ListenerPoller
 
typedef NT_Handle NT_MultiSubscriber
 
typedef NT_Handle NT_Topic
 
typedef NT_Handle NT_Subscriber
 
typedef NT_Handle NT_Publisher
 

Enumerations

enum  NT_Type {
  NT_UNASSIGNED = 0 , NT_BOOLEAN = 0x01 , NT_DOUBLE = 0x02 , NT_STRING = 0x04 ,
  NT_RAW = 0x08 , NT_BOOLEAN_ARRAY = 0x10 , NT_DOUBLE_ARRAY = 0x20 , NT_STRING_ARRAY = 0x40 ,
  NT_RPC = 0x80 , NT_INTEGER = 0x100 , NT_FLOAT = 0x200 , NT_INTEGER_ARRAY = 0x400 ,
  NT_FLOAT_ARRAY = 0x800
}
 NetworkTables data types. More...
 
enum  NT_EntryFlags { NT_PERSISTENT = 0x01 , NT_RETAINED = 0x02 , NT_UNCACHED = 0x04 }
 NetworkTables entry flags. More...
 
enum  NT_LogLevel {
  NT_LOG_CRITICAL = 50 , NT_LOG_ERROR = 40 , NT_LOG_WARNING = 30 , NT_LOG_INFO = 20 ,
  NT_LOG_DEBUG = 10 , NT_LOG_DEBUG1 = 9 , NT_LOG_DEBUG2 = 8 , NT_LOG_DEBUG3 = 7 ,
  NT_LOG_DEBUG4 = 6
}
 NetworkTables logging levels. More...
 
enum  NT_NetworkMode {
  NT_NET_MODE_NONE = 0x00 , NT_NET_MODE_SERVER = 0x01 , NT_NET_MODE_CLIENT3 = 0x02 , NT_NET_MODE_CLIENT4 = 0x04 ,
  NT_NET_MODE_STARTING = 0x08 , NT_NET_MODE_LOCAL = 0x10
}
 Client/server modes. More...
 
enum  NT_EventFlags {
  NT_EVENT_NONE = 0 , NT_EVENT_IMMEDIATE = 0x01 , NT_EVENT_CONNECTED = 0x02 , NT_EVENT_DISCONNECTED = 0x04 ,
  NT_EVENT_CONNECTION = NT_EVENT_CONNECTED | NT_EVENT_DISCONNECTED , NT_EVENT_PUBLISH = 0x08 , NT_EVENT_UNPUBLISH = 0x10 , NT_EVENT_PROPERTIES = 0x20 ,
  NT_EVENT_TOPIC = NT_EVENT_PUBLISH | NT_EVENT_UNPUBLISH | NT_EVENT_PROPERTIES , NT_EVENT_VALUE_REMOTE = 0x40 , NT_EVENT_VALUE_LOCAL = 0x80 , NT_EVENT_VALUE_ALL = NT_EVENT_VALUE_REMOTE | NT_EVENT_VALUE_LOCAL ,
  NT_EVENT_LOGMESSAGE = 0x100 , NT_EVENT_TIMESYNC = 0x200
}
 Event notification flags. More...
 

Detailed Description

Handle-based interface for C.

Macro Definition Documentation

◆ NT_DEFAULT_PORT3

#define NT_DEFAULT_PORT3   1735

Default network tables port number (NT3)

◆ NT_DEFAULT_PORT4

#define NT_DEFAULT_PORT4   5810

Default network tables port number (NT4)

Typedef Documentation

◆ NT_Bool

typedef int NT_Bool

Typedefs.

◆ NT_ConnectionDataLogger

◆ NT_DataLogger

◆ NT_Entry

◆ NT_Handle

typedef unsigned int NT_Handle

◆ NT_Inst

typedef NT_Handle NT_Inst

◆ NT_Listener

◆ NT_ListenerPoller

◆ NT_MultiSubscriber

◆ NT_Publisher

◆ NT_Subscriber

◆ NT_Topic

Enumeration Type Documentation

◆ NT_EntryFlags

NetworkTables entry flags.

Enumerator
NT_PERSISTENT 
NT_RETAINED 
NT_UNCACHED 

◆ NT_EventFlags

Event notification flags.

Enumerator
NT_EVENT_NONE 
NT_EVENT_IMMEDIATE 

Initial listener addition.

NT_EVENT_CONNECTED 

Client connected (on server, any client connected).

NT_EVENT_DISCONNECTED 

Client disconnected (on server, any client disconnected).

NT_EVENT_CONNECTION 

Any connection event (connect or disconnect).

NT_EVENT_PUBLISH 

New topic published.

NT_EVENT_UNPUBLISH 

Topic unpublished.

NT_EVENT_PROPERTIES 

Topic properties changed.

NT_EVENT_TOPIC 

Any topic event (publish, unpublish, or properties changed).

NT_EVENT_VALUE_REMOTE 

Topic value updated (via network).

NT_EVENT_VALUE_LOCAL 

Topic value updated (local).

NT_EVENT_VALUE_ALL 

Topic value updated (network or local).

NT_EVENT_LOGMESSAGE 

Log message.

NT_EVENT_TIMESYNC 

Time synchronized with server.

◆ NT_LogLevel

NetworkTables logging levels.

Enumerator
NT_LOG_CRITICAL 
NT_LOG_ERROR 
NT_LOG_WARNING 
NT_LOG_INFO 
NT_LOG_DEBUG 
NT_LOG_DEBUG1 
NT_LOG_DEBUG2 
NT_LOG_DEBUG3 
NT_LOG_DEBUG4 

◆ NT_NetworkMode

Client/server modes.

Enumerator
NT_NET_MODE_NONE 
NT_NET_MODE_SERVER 
NT_NET_MODE_CLIENT3 
NT_NET_MODE_CLIENT4 
NT_NET_MODE_STARTING 
NT_NET_MODE_LOCAL 

◆ NT_Type

enum NT_Type

NetworkTables data types.

Enumerator
NT_UNASSIGNED 
NT_BOOLEAN 
NT_DOUBLE 
NT_STRING 
NT_RAW 
NT_BOOLEAN_ARRAY 
NT_DOUBLE_ARRAY 
NT_STRING_ARRAY 
NT_RPC 
NT_INTEGER 
NT_FLOAT 
NT_INTEGER_ARRAY 
NT_FLOAT_ARRAY