OVERVIEW   INDEX   DEPRECATED   HELP   CORRESPONDENCES  


Module Parameters   Data Types   Component Types   Port Types   Constants   Templates   Signatures   Functions   Altsteps   Test Cases  

Module IMS_CommonProcedures_Registration


Import Declarations:

Groups:

Data Types Summary
SecurityClientParams_Type
Templates Summary
cs_RegistrationList
Functions Summary
f_IMS_PTC_GetPort_us
f_IMS_PTC_GetPort_ps
f_IMS_MessageHeader_CheckVia
f_IMS_MessageHeader_CheckContactAddr
f_IMS_MessageHeader_CheckTo
fl_IMS_ContactAddress_CheckParams
fl_IMS_ContactAddress_CheckHostname
fl_IMS_SecurityClient_Check
fl_IMS_Authorization_Check
fl_IMS_MessageHeader_CheckExpires
f_IMS_A_1_1_MessageHeader_CommonChecks
f_IMS_MessageHeader_CheckSigComp
f_IMS_PublicUserId_Match
fl_PublicUserIdentity_Check
f_IMS_A_1_1_MessageHeader_CheckPublicUserIdentity
fl_IMS_ReceiveOrGetRegisterRequest
f_IMS_RegisterResponse_200_MessageHeaderTX
f_IMS_RegisterResponse_401_MessageHeaderTX
f_IMS_RegisterResponse_403_MessageHeaderTX
f_IMS_SubscribeResponse_200_MessageHeaderTX
f_IMS_CommonResponse_486_MessageHeaderTX
f_IMS_CommonResponse_503_MessageHeaderTX
f_IMS_CommonResponse_603_MessageHeaderTX
fl_IMS_RegisterRequest_MessageHeaderRX_Base
f_IMS_RegisterRequest_MessageHeaderRX_Initial
f_IMS_RegisterRequest_MessageHeaderRX_Subsequent
f_IMS_RegisterRequest_MessageHeaderRX_Derregister
f_IMS_SubscribeRequest_MessageHeaderRX
f_IMS_REGISTER_InitialRequest
f_IMS_Register_SecurityInit
f_IMS_REGISTER_SubsequentRequest
f_IMS_Register_NonGIBA
f_IMS_Register_GIBA
f_IMS_Register
f_IMS_SUBSCRIBE_Request
f_IMS_SUBSCRIBE_Response
f_IMS_Register_Subscribe
f_IMS_NotifyRequest_MessageHeader_A16
f_IMS_OtherResponse_200_MessageHeaderRX
f_IMS_Register_Notify
f_XML_RegistrationInfo
f_IMS_XmlMessageForNotify_Def
f_IMS_Register_SubscribeNotify
f_IMS_PTC_Deregistration
f_IMS_PTC_ReRegistration_SecurityClientParamsGet
f_IMS_PTC_ReRegistration_SecurityClientParamsCheck
f_IMS_PTC_ReRegistration_WaitForRegistration
f_IMS_Registration
f_IMS_EmergencyRegistration_C20
f_IMS_EmergencyCallRegistration_403Forbidden

Details

SecurityClientParams_Type
type record SecurityClientParams_Type {   
PortNumber_Type Port_us,
PortNumber_Type Port_uc,
IPsec_SPI_Type  SPI_us,
IPsec_SPI_Type  SPI_uc
  }

Declared in group RegistrationFunctions

cs_RegistrationList
template (value) RegInfo_RegistrationList_Type cs_RegistrationList (template (value) RegInfo_Registration_Type p_Reg1,
                                                              template (value) RegInfo_Registration_Type p_Reg2,
                                                              template (value) RegInfo_Registration_Type p_Reg3,
                                                              template (value) RegInfo_Registration_Type p_Reg4) :=
{ p_Reg1, p_Reg2, p_Reg3, p_Reg4 };

Declared in group RegistrationFunctions

Returns: RegInfo_RegistrationList_Type -

Parameters:
f_IMS_PTC_GetPort_us
function f_IMS_PTC_GetPort_us(boolean p_IsProtected := true) runs on IMS_PTC return integer
  

Runs On: IMS_PTC

Returns: integer -

Parameters:
f_IMS_PTC_GetPort_ps
function f_IMS_PTC_GetPort_ps(boolean p_IsProtected := true) runs on IMS_PTC return integer
  

Runs On: IMS_PTC

Returns: integer -

Parameters:
f_IMS_MessageHeader_CheckVia
function f_IMS_MessageHeader_CheckVia(MessageHeader p_MessageHeader,
                                InternetProtocol_Type p_Protocol,
                                boolean p_AllowFQDN := true) runs on IMS_PTC
  

Declared in group CheckFunctions

Runs On: IMS_PTC

Returns: void -

Parameters:
f_IMS_MessageHeader_CheckContactAddr
function f_IMS_MessageHeader_CheckContactAddr(MessageHeader p_MessageHeader,
                                        boolean p_AllowGRUU := false,
                                        boolean p_AllowFQDN := true) runs on IMS_PTC
  

Declared in group CheckFunctions

Runs On: IMS_PTC

Returns: void -

Parameters:
f_IMS_MessageHeader_CheckTo
function f_IMS_MessageHeader_CheckTo(To p_To,
                               boolean p_CheckNoTag := true) runs on IMS_PTC
  

Declared in group CheckFunctions

Runs On: IMS_PTC

Returns: void -

Parameters:
fl_IMS_ContactAddress_CheckParams
function fl_IMS_ContactAddress_CheckParams(ContactAddress p_ContactAddress,
                                     boolean p_CondA7 := false,
                                     boolean p_IMS_MTSI := tsc_IMS_MTSI,
                                     boolean p_IMS_GRUUsInSIP := pc_IMS_GRUUsInSIP,
                                     boolean p_IMS_SMSoverIMS := tsc_IMS_SMSoverIMS,
                                     boolean p_Video := tsc_IMS_VideoFeature) runs on IMS_PTC
  

Declared in group CheckFunctions

Runs On: IMS_PTC

Returns: void -

Parameters:
fl_IMS_ContactAddress_CheckHostname
function fl_IMS_ContactAddress_CheckHostname(ContactAddress p_ContactAddress,
                                       IP_AddrInfo_Type p_UE_Address) runs on IMS_PTC
  

Declared in group CheckFunctions

Runs On: IMS_PTC

Returns: void -

Parameters:
fl_IMS_SecurityClient_Check
function fl_IMS_SecurityClient_Check(SecurityClient p_SecClient,
                               boolean p_Confidentiality := tsc_IMS_Confidentiality) runs on IMS_PTC
  

Declared in group CheckFunctions

Runs On: IMS_PTC

Returns: void -

Parameters:
fl_IMS_Authorization_Check
function fl_IMS_Authorization_Check(Authorization p_Authorization) runs on IMS_PTC
  

Declared in group CheckFunctions

Runs On: IMS_PTC

Returns: void -

Parameters:
fl_IMS_MessageHeader_CheckExpires
function fl_IMS_MessageHeader_CheckExpires(MessageHeader p_MessageHeader,
                                     template (omit) charstring p_ExplicitExpiry := omit) runs on IMS_PTC
  

Declared in group CheckFunctions

Runs On: IMS_PTC

Returns: void -

Parameters:
f_IMS_A_1_1_MessageHeader_CommonChecks
function f_IMS_A_1_1_MessageHeader_CommonChecks(MessageHeader p_MessageHeader,
                                          InternetProtocol_Type p_Protocol,
                                          boolean p_CondA7 := false,
                                          template (omit) IP_AddrInfo_Type p_UE_Address := omit,
                                          template (omit) charstring p_ExplicitExpiry := omit,
                                          boolean p_CheckAuthorization := true) runs on IMS_PTC
  

Declared in group CheckFunctions

Runs On: IMS_PTC

Returns: void -

Parameters:
f_IMS_MessageHeader_CheckSigComp
function f_IMS_MessageHeader_CheckSigComp(MessageHeader p_MessageHeader) runs on IMS_PTC
  

Declared in group CheckFunctions

Runs On: IMS_PTC

Returns: void -

Parameters:
f_IMS_PublicUserId_Match
function f_IMS_PublicUserId_Match(CharStringList_Type p_PublicUserIdentityList,
                           SipUrl p_SipUrl) return boolean
  

Declared in group CheckFunctions

Returns: boolean -

Parameters:
fl_PublicUserIdentity_Check
function fl_PublicUserIdentity_Check(SipUrl p_SipUrl,
                               boolean p_CondA7 := false) runs on IMS_PTC return boolean
  

Declared in group CheckFunctions

Runs On: IMS_PTC

Returns: boolean -

Parameters:
f_IMS_A_1_1_MessageHeader_CheckPublicUserIdentity
function f_IMS_A_1_1_MessageHeader_CheckPublicUserIdentity(MessageHeader p_MessageHeader,
                                                     boolean p_CondA7 := false) runs on IMS_PTC
  

Declared in group CheckFunctions

Runs On: IMS_PTC

Returns: void -

Parameters:
fl_IMS_ReceiveOrGetRegisterRequest
function fl_IMS_ReceiveOrGetRegisterRequest(template (omit) IMS_DATA_REQ p_IMS_DATA_REQ) runs on IMS_PTC return IMS_DATA_REQ
  

Declared in group SendReceiveFunctions

Runs On: IMS_PTC

Returns: IMS_DATA_REQ -

Parameters:
f_IMS_RegisterResponse_200_MessageHeaderTX
function f_IMS_RegisterResponse_200_MessageHeaderTX(REGISTER_Request p_RegisterRequest,
                                              boolean p_CondA3 := false,
                                              charstring p_RegisterExpiration := tsc_IMS_RegisterExpiration) runs on IMS_PTC return template (value) MessageHeader
  

Declared in group SendReceiveFunctions

Runs On: IMS_PTC

Returns: MessageHeader -

Parameters:
f_IMS_RegisterResponse_401_MessageHeaderTX
function f_IMS_RegisterResponse_401_MessageHeaderTX(REGISTER_Request p_RegisterRequest,
                                              template (omit) charstring p_Nonce := omit) runs on IMS_PTC return template (value) MessageHeader
  

Declared in group SendReceiveFunctions

Runs On: IMS_PTC

Returns: MessageHeader -

Parameters:
f_IMS_RegisterResponse_403_MessageHeaderTX
function f_IMS_RegisterResponse_403_MessageHeaderTX(REGISTER_Request p_RegisterRequest) return template (value) MessageHeader
  

Declared in group SendReceiveFunctions

Returns: MessageHeader -

Parameters:
f_IMS_SubscribeResponse_200_MessageHeaderTX
function f_IMS_SubscribeResponse_200_MessageHeaderTX(SUBSCRIBE_Request p_SubscribeRequest,
                                               template (value) RecordRoute p_RecordRoute,
                                               charstring p_ExpireTime := "600000") return template (value) MessageHeader
  

Declared in group SendReceiveFunctions

Returns: MessageHeader -

Parameters:
f_IMS_CommonResponse_486_MessageHeaderTX
function f_IMS_CommonResponse_486_MessageHeaderTX(MessageHeader p_MessageHeader_Request) return template (value) MessageHeader
  

Declared in group SendReceiveFunctions

Returns: MessageHeader -

Parameters:
f_IMS_CommonResponse_503_MessageHeaderTX
function f_IMS_CommonResponse_503_MessageHeaderTX(MessageHeader p_MessageHeader_Request,
                                            template (value) RetryAfter p_RetryAfter) return template (value) MessageHeader
  

Declared in group SendReceiveFunctions

Returns: MessageHeader -

Parameters:
f_IMS_CommonResponse_603_MessageHeaderTX
function f_IMS_CommonResponse_603_MessageHeaderTX(MessageHeader p_MessageHeader_Request) return template (value) MessageHeader

Declared in group SendReceiveFunctions

Returns: MessageHeader -

Parameters:
fl_IMS_RegisterRequest_MessageHeaderRX_Base
function fl_IMS_RegisterRequest_MessageHeaderRX_Base(boolean p_CondA3,
                                               template (present) integer p_CseqValue,
                                               boolean p_SessionIdSupported := false) return template (present) MessageHeader
  

Declared in group SendReceiveFunctions

Returns: MessageHeader -

Parameters:
f_IMS_RegisterRequest_MessageHeaderRX_Initial
function f_IMS_RegisterRequest_MessageHeaderRX_Initial(boolean p_CondA3 := false) runs on IMS_PTC return template (present) MessageHeader
  

Declared in group SendReceiveFunctions

Runs On: IMS_PTC

Returns: MessageHeader -

Parameters:
f_IMS_RegisterRequest_MessageHeaderRX_Subsequent
function f_IMS_RegisterRequest_MessageHeaderRX_Subsequent(integer p_NonceCount := 1) runs on IMS_PTC return template (present) MessageHeader
  

Declared in group SendReceiveFunctions

Runs On: IMS_PTC

Returns: MessageHeader -

Parameters:
f_IMS_RegisterRequest_MessageHeaderRX_Derregister
function f_IMS_RegisterRequest_MessageHeaderRX_Derregister(boolean p_CondA3 := false) runs on IMS_PTC return template (present) MessageHeader
  

Declared in group SendReceiveFunctions

Runs On: IMS_PTC

Returns: MessageHeader -

Parameters:
f_IMS_SubscribeRequest_MessageHeaderRX
function f_IMS_SubscribeRequest_MessageHeaderRX(boolean p_IsGIBA := false,
                                          EventType p_EventType := "reg",
                                          template SipUrl p_SipUrlTo := omit,
                                          charstring p_ExpireTime := "600000",
                                          boolean p_SessionIdSupported := false) runs on IMS_PTC return template (present) MessageHeader
  

Declared in group SendReceiveFunctions

Runs On: IMS_PTC

Returns: MessageHeader -

Parameters:
f_IMS_REGISTER_InitialRequest
function f_IMS_REGISTER_InitialRequest(template (omit) IMS_DATA_REQ p_IMS_DATA_REQ := omit,
                                 template (omit) charstring p_ExplicitExpiry := omit,
                                 boolean p_SigCompIsActive := false,
                                 boolean p_CondA3 := false,
                                 boolean p_CondA7 := false) runs on IMS_PTC return IMS_DATA_REQ
  

Declared in group RegistrationFunctions

Runs On: IMS_PTC

Returns: IMS_DATA_REQ -

Parameters:
f_IMS_Register_SecurityInit
function f_IMS_Register_SecurityInit(REGISTER_Request p_RegisterReq,
                               template (value) B128_Type p_Rand := tsc_IMS_AuthRAND,
                               boolean p_IsGIBA := false) runs on IMS_PTC
  

Declared in group RegistrationFunctions

Runs On: IMS_PTC

Returns: void -

Parameters:
f_IMS_REGISTER_SubsequentRequest
function f_IMS_REGISTER_SubsequentRequest(template (omit) IMS_DATA_REQ p_IMS_DATA_REQ := omit,
                                    boolean p_CondA7 := false,
                                    integer p_NonceCount := 1,
                                    template (omit) charstring p_ExplicitExpiry := omit) runs on IMS_PTC  return IMS_DATA_REQ
  

Declared in group RegistrationFunctions

Runs On: IMS_PTC

Returns: IMS_DATA_REQ -

Parameters:
f_IMS_Register_NonGIBA
function f_IMS_Register_NonGIBA(template (omit) IMS_DATA_REQ p_IMS_DATA_REQ := omit,
                          charstring p_RegisterExpiration := tsc_IMS_RegisterExpiration,
                          boolean p_SigCompIsActive := false,
                          boolean p_IsEmergency := false) runs on IMS_PTC return REGISTER_Request
  

Declared in group RegistrationFunctions

Runs On: IMS_PTC

Returns: REGISTER_Request -

Parameters:
f_IMS_Register_GIBA
function f_IMS_Register_GIBA(template (omit) IMS_DATA_REQ p_IMS_DATA_REQ := omit,
                       charstring p_RegisterExpiration := tsc_IMS_RegisterExpiration) runs on IMS_PTC return REGISTER_Request
  

Declared in group RegistrationFunctions

Runs On: IMS_PTC

Returns: REGISTER_Request -

Parameters:
f_IMS_Register
function f_IMS_Register(boolean p_IsGIBA := false,
                  template (omit) IMS_DATA_REQ p_IMS_DATA_REQ := omit,
                  boolean p_SigCompIsActive := false) runs on IMS_PTC return REGISTER_Request
  

Declared in group RegistrationFunctions

Runs On: IMS_PTC

Returns: REGISTER_Request -

Parameters:
f_IMS_SUBSCRIBE_Request
function f_IMS_SUBSCRIBE_Request(boolean p_IsGIBA := false,
                           EventType p_EventType := "reg",
                           charstring p_ExpireTime := "600000") runs on IMS_PTC return IMS_DATA_REQ
  

Declared in group RegistrationFunctions

Runs On: IMS_PTC

Returns: IMS_DATA_REQ -

Parameters:
f_IMS_SUBSCRIBE_Response
function f_IMS_SUBSCRIBE_Response(IMS_DATA_REQ p_IMS_Subscribe_Request,
                            boolean p_IsGIBA := false,
                            charstring p_ExpireTime := "600000") runs on IMS_PTC
  

Declared in group RegistrationFunctions

Runs On: IMS_PTC

Returns: void -

Parameters:
f_IMS_Register_Subscribe
function f_IMS_Register_Subscribe(boolean p_IsGIBA := false) runs on IMS_PTC return SUBSCRIBE_Request
  

Declared in group RegistrationFunctions

Runs On: IMS_PTC

Returns: SUBSCRIBE_Request -

Parameters:
f_IMS_NotifyRequest_MessageHeader_A16
function f_IMS_NotifyRequest_MessageHeader_A16(SUBSCRIBE_Request p_SubscribeRequest,
                                         boolean p_CondA2,
                                         integer p_CseqValue,
                                         template (value) SubscriptionState p_SubscriptionState) runs on IMS_PTC return template (value) MessageHeader
  

Declared in group RegistrationFunctions

Runs On: IMS_PTC

Returns: MessageHeader -

Parameters:
f_IMS_OtherResponse_200_MessageHeaderRX
function f_IMS_OtherResponse_200_MessageHeaderRX(template (value) MessageHeader p_MessageHeader_Request,
                                           template ContentType p_ContentType := *) runs on IMS_PTC return template (present) MessageHeader
  

Declared in group RegistrationFunctions

Runs On: IMS_PTC

Returns: MessageHeader -

Parameters:
f_IMS_Register_Notify
function f_IMS_Register_Notify(SipUrl p_ContactUrl,
                         SUBSCRIBE_Request p_SubscribeRequest,
                         template (value) Reginfo_Type p_XmlMessage,
                         boolean p_CondA2 := false,
                         integer p_CseqValue := 1,
                         template (value) SubscriptionState p_SubscriptionState := cs_SubscriptionState_Active) runs on IMS_PTC
  

Declared in group RegistrationFunctions

Runs On: IMS_PTC

Returns: void -

Parameters:
f_XML_RegistrationInfo
function f_XML_RegistrationInfo(REGISTER_Request p_RegisterRequest,
                          charstring p_Uri,
                          charstring p_RegistrationId,
                          charstring p_ContactId,
                          RegInfo_Contact_State_Type p_ContactState := active,
                          RegInfo_Contact_Event_Type p_ContactEvent := registered,
                          template (omit) integer p_Expires := omit,
                          boolean p_ApplyGRUU := pc_IMS_GRUUsInSIP,
                          boolean p_IsTelUri := false)
return template (value) RegInfo_Registration_Type
  

Declared in group RegistrationFunctions

Returns: RegInfo_Registration_Type -

Parameters:
f_IMS_XmlMessageForNotify_Def
function f_IMS_XmlMessageForNotify_Def(REGISTER_Request p_RegisterRequest) runs on IMS_PTC return template (value) Reginfo_Type
  

Declared in group RegistrationFunctions

Runs On: IMS_PTC

Returns: Reginfo_Type -

Parameters:
f_IMS_Register_SubscribeNotify
function f_IMS_Register_SubscribeNotify(REGISTER_Request p_RegisterRequest,
                                  boolean p_IsGIBA := false) runs on IMS_PTC return SUBSCRIBE_Request
  

Declared in group RegistrationFunctions

Runs On: IMS_PTC

Returns: SUBSCRIBE_Request -

Parameters:
f_IMS_PTC_Deregistration
function f_IMS_PTC_Deregistration(template (omit) IMS_DATA_REQ p_IMS_DATA_REQ := omit,
                            boolean p_CondA3 := false) runs on IMS_PTC
  

Declared in group RegistrationFunctions

Runs On: IMS_PTC

Returns: void -

Parameters:
f_IMS_PTC_ReRegistration_SecurityClientParamsGet
function f_IMS_PTC_ReRegistration_SecurityClientParamsGet()
runs on IMS_PTC return SecurityClientParams_Type
  

Declared in group RegistrationFunctions

Runs On: IMS_PTC

Returns: SecurityClientParams_Type -

f_IMS_PTC_ReRegistration_SecurityClientParamsCheck
function f_IMS_PTC_ReRegistration_SecurityClientParamsCheck(REGISTER_Request p_RegisterReq,
                                                      SecurityClientParams_Type p_PrevSecurityClientParams)
runs on IMS_PTC return SecurityClientParams_Type
  

Declared in group RegistrationFunctions

Runs On: IMS_PTC

Returns: SecurityClientParams_Type -

Parameters:
f_IMS_PTC_ReRegistration_WaitForRegistration
function f_IMS_PTC_ReRegistration_WaitForRegistration(timer p_TRegExpire,
                                                integer p_Nc)
runs on IMS_PTC return IMS_DATA_REQ
  

Declared in group RegistrationFunctions

Runs On: IMS_PTC

Returns: IMS_DATA_REQ -

Parameters:
f_IMS_Registration
function f_IMS_Registration(boolean p_IsGIBA := false,
                      template (omit) IMS_DATA_REQ p_IMS_DATA_REQ := omit,
                      boolean p_SigCompIsActive := false) runs on IMS_PTC
  

Declared in group RegistrationFunctions

Runs On: IMS_PTC

Returns: void -

Parameters:
f_IMS_EmergencyRegistration_C20
function f_IMS_EmergencyRegistration_C20() runs on IMS_PTC return REGISTER_Request
  

Declared in group RegistrationFunctions

Runs On: IMS_PTC

Returns: REGISTER_Request -

f_IMS_EmergencyCallRegistration_403Forbidden
function f_IMS_EmergencyCallRegistration_403Forbidden() runs on IMS_PTC return REGISTER_Request
  

Declared in group RegistrationFunctions

Runs On: IMS_PTC

Returns: REGISTER_Request -