NMS V5 library structures

When using the NMS V5 library, applications can send or receive the following structures:

Structure	Description
NMS_V5_BOARD_FAMILY_T	Applications send this structure to specify the board family (CG boards) used on the host system.
NMS_V5_E1_LOCATION_T	Applications send this structure to specify the location of an E1 link on a CG board.
NMS_V5_CHANNEL_LOCATION_T	Applications send this structure to specify the location of an HDLC channel on a CG board.
NMS_V5_E1_STATUS_T	The NMS V5 library returns this structure to indicate the status of a particular E1 link.
NMS_V5_CHANNEL_STATISTICS_T	The NMS V5 library returns this structure to provide statistics about the transmit or receive operations on HDLC channels.

NMS_V5_BOARD_FAMILY_T

When applications initialize the NMS V5 library, they specify the board family with the NMS_V5_BOARD_FAMILY_T structure:

typedef enum _NMS_V5_BOARD_T
{
NMS_BOARD_FAMILY_CG
} NMS_V5_BOARD_FAMILY_T;

Dependent function: NMS_V5Initialize

Field name	Type	Default	Description
NMS_BOARD_FAMILY_CG	NMS_V5_BOARD_FAMILY_T	N/A	Specifies the board family (CG boards) used on the system.

NMS_V5_E1_LOCATION_T

When applications obtain or reset E1 link status information, they specify the E1 link information through NMS_V5_E1_LOCATION_T:

typedef union _NMS_V5_E1_LOCATION_T
{
    struct {
        DWORD boardNb;
        DWORD trunkNb;
    } CG;
} NMS_V5_E1_LOCATION_T;

Dependent function: NMS_V5ProvisionInterface, NMS_V5ProvisionStandByVariant, NMS_V5AddE1, NMS_V5DeleteE1, NMS_V5GetE1Status, NMS_V5ResetE1Status, or NMS_V5SendSA7Bit

Field name	Type	Default	Units	Description
boardNb	DWORD	N/A	N/A	Logical board number of the board where the E1 link is located (as defined by NMS OAM).
trunkNb	DWORD	N/A	N/A	Logical trunk number associated with the E1 link (as defined by NMS OAM).

NMS_V5_CHANNEL_LOCATION_T

When applications obtain or reset HDLC channel statistics or modify a channel location, they specify the HDLC channel information through a NMS_V5_CHANNEL_LOCATION_T structure:

typedef union _NMS_V5_CHANNEL_LOCATION_T
{
    struct {
        DWORD boardNb;
        DWORD trunkNb;
        DWORD timeslotNb;
    } CG;
} NMS_V5_CHANNEL_LOCATION_T;

Dependent functions: NMS_V5ProvisionInterface, NMS_V5ProvisionStandByVariant, NMS_V5PhSendData, NMS_V5GetChannelStatistics, or NMS_V5SendSA7Bit

Field name	Type	Default	Units	Description
boardNb	DWORD	N/A	N/A	Logical board number of the board where the HDLC instance is located as defined by NMS OAM.
trunkNb	DWORD	N/A	N/A	Logical trunk number associated with the HDLC instance (as defined by NMS OAM).
timeslotNb	DWORD	N/A	N/A	Physical timeslot number associated with the HDLC instance.

NMS_V5_E1_STATUS_T

When the NMS V5 library returns information about the status of an E1 link, it provides the information in a NMS_V5_E1_STATUS_T structure:

typedef struct {
    DWORD Size;
    NMS_V5_E1_STATUSMASK_T StatusMask;
    DWORD Slips;
    DWORD Es;
    DWORD Ses;
    DWORD Uas;
    DWORD LineErrors;
    DWORD FrameErrors;
    DWORD ElaspedTime;
} NMS_V5_E1_STATUS_T;

Dependent function: NMS_V5GetE1Status

Field name	Type	Units	Description
Size	DWORD	N/A	Size of the structure.
StatusMask	NMS_V5_E1_ STATUSMASK_T	N/A	Current E1 status bit mask. This can combine the following values: NMSV5_E1_LOS (0x01) Loss of signal. NMSV5_E1_LOF (0x02) Loss of frame. NMSV5_E1_AIS (0x04) Alarm indication signal. NMSV5_E1_RAI (0x08) Remote alarm indicator. NMSV5_E1_CRC_BLOCK_ERR (0x010) CRC block error. NMSV5_E1_CRC_BLOCK_INFO (0x020) CRC block information (FEBE). NMSV5_E1_NORMAL_FRAMES_0 (0x040) Normal E1 frames (remote SA7 = 0). NMSV5_E1_NORMAL_FRAMES_1 (0x080) Normal E1 frames (remote SA7 = 1).
Slips	DWORD	count	Number of slips.
Es	DWORD	count	Number of errors seconds.
Ses	DWORD	count	Number of severely errored seconds.
Uas	DWORD	count	Number of unavailable seconds.
LineErrors	DWORD	count	Number of line code violations.
FrameErrors	DWORD	count	Number of frame bit errors and CRC errors.
ElaspedTime	DWORD	count	Seconds since counters started. This represents the duration of the observation time (in seconds). Note: All statistics are the count of particular events that occur during the ElaspedTime interval.

NMS_V5_CHANNEL_STATISTICS_T

When the NMS GR303 library returns HDLC channel statistics, it provides the information in an NMS_V5_CHANNEL_STATISTICS_T structure (which includes both a CHANNEL_STATISTICS_RECEIVE_T or CHANNEL_STATISTICS_TRANSMIT_T substructure):

typedef struct {
   DWORD Size; /* Size of this structure */
   CHANNEL_STATISTICS_RECEIVE_T  chan_stat_rx;
   CHANNEL_STATISTICS_TRANSMIT_T chan_stat_tx;
} NMS_V5_CHANNEL_STATISTICS_T;

typedef struct {
   DWORD Octets;
   DWORD Frames;
   DWORD Drops;
   DWORD FifoOverruns;
   DWORD Aborts;
   DWORD CrcErrors;
   DWORD NonAlignedOctets;
   DWORD BufferOverflows;
} CHANNEL_STATISTICS_RECEIVE_T;

typedef struct {
   DWORD Octets;
   DWORD Frames;
   DWORD Drops;
   DWORD FifoUnderruns;
   DWORD FifoOverruns;
} CHANNEL_STATISTICS_TRANSMIT_T;

CHANNEL_STATISTICS_RECEIVE_T

Dependent function: NMS_V5GetChannelStatistics

Field name	Type	Units	Description
Octets	DWORD	count	Bytes received count.
Frames	DWORD	count	Frames received count.
Drops	DWORD	count	Frames dropped count.
FifoOverruns	DWORD	count	FIFO overrun count. Not supported on CG 6100C or CG 6500C boards.
Aborts	DWORD	count	Receive abort count.
CrcErrors	DWORD	count	Receive CRC errors count.
NonAlignedOctets	DWORD	count	Non-aligned octets count. Not supported on CG 6100C or CG 6500C boards.
BufferOverflows	DWORD	count	Buffer overflows count. Not supported on CG 6100C or CG 6500C boards.

CHANNEL_STATISTICS_TRANSMIT_T

Dependent function: NMS_V5GetChannelStatistics

Field name	Type	Units	Description
Octets	DWORD	count	Bytes transmitted count.
Frames	DWORD	count	Frames transmitted count.
Drops	DWORD	count	Frames dropped count.
FifoUnderruns	DWORD	count	FIFO underrun count. Not supported on CG 6100C or CG 6500C boards.
FifoOverruns	DWORD	count	FIFO overrun count. Not supported on CG 6100C or CG 6500C boards.