API Documentation

NxAccessStatus

NxAccessStatus is only non-null when your program is connected to a NxCoreAccess and you're processing a real-time tape. On processing historical tapes, all pointers to NxAccessStatus will obviously be null.

NxAccessStatus is defined in NxCoreAPI.h as:


struct NxAccessStatus {
  unsigned int    Version;
  int             AcctExpireDays;
  unsigned char   Status;
  unsigned char   AttnLevel;
  unsigned char   StatusMCS;
  unsigned char   AttnLevelMCS;
  unsigned short  UDPPingTime;
  unsigned short  UDPPktLossPct;
  int             NxClockDiff;
  unsigned int    NxClockReceived;
  int             SysClockDrift;
  unsigned int    SecondsRunning;
  unsigned int    RecvBytes;
  unsigned int    SendBytes;
  unsigned short  MCClients;
  unsigned short  MCCLicenses;
  unsigned char   ChatMsgIndc;
};

Version

The Version of NxCore Access running

AcctExpireDays

The number of days remaining until this account expires

Status

Current status of NxCore Access

Value Meaning
0 Not Running
1 Stand-By
2 Verify
3 Verify Complete
4 TCP Connect
5 MCast Connect
6 Delayed Ahead
7 Tape Unavailable
8
9
10 TCP
11 UDP
12 Multicast
13 Multicast Restore
14 TCP DELAYED
15 History Only
16
17
18
19 UDP Ready
20 TCP to UDP
21
22
23
24
25
26
27
28 UDP Resend
29 Multicast Idle
30 TCP Connect Failed
31 TCP Receive Failed
32 No Multicast Server
33
34
35
36
37 Tape Failed
38 Check Disk
39
40
41
42
43
44
45
46
47 Logon Failed
48 Account Disabled
49 Account in Use
50 Please Contact Nanex
51 Need Multicast License

AttnLevel

A number between 0 and 4 indicating if there is a problem and its severity

StatusMCS

Set when NxCore Access is a Multicast Client. This is the status of the Multicast Server it is connected to

AttnLevelMCS

Indicates if there is a problem on the multicast server that NxCore Access is connected to

UDPPingTime

Round-trip ping and server processing time in milliseconds, updated every 10-60 seconds

UDPPktLossPct

Running average count of UDP packets that were resent per 1000 packets received

NxClockDiff

Average of the time differences between the adjusted system clock and the NxCore Clock messages as they are read in the NxCore tape. Note: excludes ping time from result

NxClockReceived

Estimated number of seconds behind NxCore Access most recent data

SysClockDrift

Estimated System Clock drift from True Time in milliseconds. If Synchronize Clock is enabled, the amount in this field will be subtracted from the system clock at the next hourly synchronization.

SecondsRunning

The number of seconds since NxCore Access was started

RecvBytes

Total bytes received in the last second (divide by 1000 to get KBps, 10000 to get kbps)

SendBytes

Total bytes sent to local Multicast Clients (Multicast Server Only) (divide by 1000 to get KBps, 10000 to get kbps)

MCClients

Number of Active Multicast Clients (Multicast Server Only)

MCCLicenses

Number of authorized Multicast Client connections (Multicast Server Only)

ChatMsgIndc

Number of chats received