Dependent functions: M3uaGetPspCfg, M3uaInitPspCfg, M3uaSetPspCfg
The following M3UAPspCfg structure contains M3UA peer signaling parameters. Bold text indicates fields you can set. Unbolded fields are either unused or for internal use only. They are set to correct values by M3uaInitPspCfg and must not be overridden.
typedef struct _M3UAPspCfg /* Peer Signalling Process configuration */
{
U16 pspId; /* PSP id */
U8 pspType; /* PSP client/server type */
U8 ipspMode; /* IPSP single ended/double ended type */
Bool dynRegRkallwd; /* PSP is authorized for DRKM mesg */
U8 dfltLshareMode; /* Default mode for dynamic cfg of ps */
Bool nwkAppIncl; /* Network Appearance flag */
Bool rxTxAspId; /* ASP Id parameter */
U32 selfAspId; /* ASP Id to be sent in ASP UP message */
U8 nwkId; /* Default network ID */
Bool cfgForAllLps; /* Configure for all local PSs? */
U16 spare1 /* Alginment
AssocCfg assocCfg; /* Association configuration */
} M3UAPspCfg;
Note: Peer signaling process 0 (pspId 0) is the local peer signaling process and is automatically created by the M3UA layer during initialization. It cannot be configured.
The following table describes the fields in the M3UAPspCfg structure that you can set:
Field |
Type |
Default |
Re-configurable? |
Description |
pspId |
U16 |
1 |
No |
Peer signaling process identifier. Values range from 1 to the result of (MAX_PSP - 1). pspId 0 is created internally and is reserved for the local peer signaling process. |
pspType |
U8 |
M3UA_PSPTYPE_IPSP |
No |
Remote peer signaling process type. Valid values are: M3UA_PSPTYPE_SGP = Process is a signaling gateway process. M3UA_PSPTYPE_IPSP = Process is an IP service process. |
ipspMode |
U8 |
M3UA_IPSMODE_SE |
No |
(Valid when the value of the pspType field is M3UA_PSPTYPE_IPSP) Indicates whether the IP service process mode is single-ended or double-ended. Valid values are: M3UA_IPSMODE_DE = Double-ended mode. M3UA_IPSMODE_SE = Single-ended mode. |
dynRegRkallwd |
Bool |
FALSE |
No |
Indicates whether this peer signaling process can send and receive DRKM (Dynamic Routing Key Management) messages. Valid values are: TRUE = Peer signaling process can send and receive DRKM messages. FALSE = Peer signaling process cannot send or receive DRKM messages. |
nwkAppIncl |
Bool |
FALSE |
Yes |
Determines whether the optional network appearance parameter is included when communicating with the remote peer. Valid values are: TRUE = Includes the network appearance parameter. FALSE = Does not include the network appearance parameter. |
rxTxAspId |
Bool |
0 |
Yes |
Indicates whether an application server process identifier is required to be sent or received in ASPUP (ASP Up) and ASPUP ACK (ASP Up Acknowledgement) messages. Valid values are: M3UA_RX_ASPID = ASP ID is required in received ASPUP and ASPUP ACK messages. M3UA_TX_ASPID = Identifier is required in transmitted ASPUP and ASPUP ACK messages. |
selfAspId |
U32 |
0 |
Yes, in the ASP Down state only |
ASP identifier to send if required by the rxTxAspId field. |
nwkId |
U8 |
1 |
Yes |
Default network context identifier for incoming messages, if the messages do not include one. |
assocCfg |
Structure |
Refer to structure. |
Refer to structure. |
Remote association configuration, defined by AssocCfg. |