RTP IPv6 simplex send endpoint filter

Provide an exit point for simplex voice over IPv6 data stream (data that includes RTP headers within UDP packets) transferred to the IP interface. For information about RTP IPv6 endpoint parameters, refer to RTP IPv6 endpoint address structure and RTP IPv6 endpoint parameter structure.

Filter ID

MSP_ENDPOINT_RTPOUT_V6

Initialization structure

RTPRTCP_V6_ENDPOINT_PARMS

Restrictions

Used in the voice processing connections.

Channel connections

Can connect to simplex voice encode channels.

Commands

RTP IPv6 simplex send endpoint filters respond to the following commands:

Command ID	Description
MSP_CMD_RTPOUT_V6_CONFIG	Sends an msp_ENDPOINT_RTPOUT_V6_CONFIG structure that specifies configuration parameters for the endpoint. RTP IPv6 send endpoints must be in a disabled state to receive MSP_CMD_RTPOUT_V6_CONFIG commands.
MSP_CMD_RTPOUT_RTCP_EVENTS	Enables or disables sending RTCP reports to the application through unsolicited events.
MSP_CMD_RTPOUT_LINK_EVENTS	Enables or disables reporting of link availability transitions through unsolicited events.
MSP_CMD_RTPOUT_CHG_QUOTA	Sets the number of frames to be assembled per packet (default is two frames per packet).

RTP IPv6 send endpoints can receive commands any time after the endpoint is created except for the MSP_CMD_RTPOUT_V6_CONFIG command. The RTP send endpoint must be disabled to receive MSP_CMD_RTPOUT_V6_CONFIG commands.

When sending MSP_CMD_RTPOUT_V6_CONFIG commands, applications provide a pointer to an msp_ENDPOINT_RTOUT_V6_CONFIG structure. This structure contains all of the parameters used to configure the RTP endpoint when the application created it parameters that do not apply to the specific endpoint type, for example, disassembler parameters for a simplex send endpoints are ignored by the MSPP API.

When using the MSP_CMD_RTPOUT_V6_CONFIG command, applications can specify a value of 0xFFFF for 16-bit parameters or 0xFFFFFFFF for 32-bit parameters (or -1 in decimal format) to retain the existing settings for any endpoint parameters. Otherwise the MSPP API expects a new value for every parameter in the msp_ENDPOINT_RTOUT_V6_CONFIG structure.

For a list of command IDs and their associated structures, refer to the mspcmd.h or mspinit.h header files.

Queries

RTP simplex send endpoint filters respond to the following query:

Query ID	Description
MSP_QRY_RTPOUT_V6_STATUS	Returns information about the RTP endpoint filter state in an msp_FILTER_RTPOUT_V6_STATUS structure.

Sending an MSP_QRY_RTPOUT_V6_STATUS query returns the following structure:

typedef struct tag_msp_ENDPOINT_RTPOUT_V6_STATUS {

   // RTP Data
   DWORD        FilterId;
   DWORD        ipFilterState;
   IPV6ADDR     localIPv6Addr;
   DWORD        localPort;
   IPV6ADDR     remoteIPv6Addr;
   DWORD        remotePort;
   DWORD        rtcpEvents;
   DWORD        linkEvents;
   DWORD        trafficClass;
   DWORD        flowLabel;
   DWORD        linkNum;

   // RTP Stats
   DWORD        txDrop;
   DWORD        txFail;
   DWORD        txPkts;
   DWORD        txBytes;

   // RTP Assembler Data
   DWORD        frame_quota;
   DWORD        assemble_dtmfFrames;

}msp_ENDPOINT_RTPOUT_V6_STATUS;

The returned query structure provides the following information:

Field	Description
FilterId	Reserved.
ipFilterState	Indicates the current state of the filter and the socket state with the CG board IP stack: Created (0x00) The filter is created. Configured (0x01) The filter is configured with its IP and RTP parameters. Starting (0x02) The filter is enabled and is in the process of opening a socket with the CG board IPv6 stack. Active (0x03) The filter has an open socket and is processing RTP data. Stopping (0x04) The filter is disabled and is in the process of closing its socket with the CG board IPv6 stack. Stop/Destroy (0x05) The filter received a destroy indication, and it is in the process of closing its socket with the CG board IPv6 stack prior to destroying itself. Destroying (0x06) The filter is cleaning up all on-board resources prior to destroying itself.
localIPv6Addr	IPv6 address of the Ethernet interface this RTP session is running on.
localPort	Local UDP port number for this RTP session.
remoteIPv6Addr	IPv6 address of the destination for this RTP session.
remotePort	UDP port number used at the destination RTP session.
rtcpEvents	Indicates whether or not the endpoint is configured to generate RTCP report events.
linkEvents	Indicates whether or not the endpoint is configured to generate route availability events.
trafficClass	Class or priority of the IPv6 packet.
flowLabel	Specific sequence to which the IPv6 packet belongs.
linkNum	Ethernet interface number (1 or 2).
txDrop	Number of RTP packets that the filter is not able to send out through the IP interface due to internal error conditions.
txFail	Number of socket send errors that occurred.
txPkts	Number of RTP packets delivered to the socket layer of the CG board's IP stack.
txBytes	Number of bytes delivered to the socket layer of the CG board's IP stack.
frame_quota	Number of media frames assembled in each payload.
assemble_dtmfFrames	Number of outbound inband DTMF frames sent.

Unsolicited events

RTP IPv6 full simplex send endpoints can return the following unsolicited events:

Event	Description
MSPEVN_RTCP_REPORT	Returns session information about an active RTP/RTCP session.
MSPEVN_NOROUTE_AVAILABLE	Indicates that an RTP endpoint lost the ability to route outbound data to its destination.
MSPEVN_ROUTE_AVAILABLE	Indicates that an RTP endpoint formerly incapable of transmitting data is now back in service.

For more information about RTP endpoint unsolicited events or inband DTMF carriage, refer to the Dialogic® NaturalAccess™ Fusion VoIP API Developer's Manual.

Details

For more information about sending information to a packet network through RTP simplex send endpoints, refer to the RTP IPv6 full duplex endpoint filter.

The following illustration shows an RTP IPv6 simplex send endpoint filter: