OVERVIEW   INDEX   DEPRECATED   HELP   CORRESPONDENCES  


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

Module LibMsrp_Templates


Import Declarations:

Groups:

Constants Summary
c_OKCode 200 status OK
c_BadRequestCode 400 status Bad request
c_ForbiddenCode 403 status Forbidden
c_RequestTimeoutCode 408 status Request Time-out
c_RequestEntityTooLargeCode 413 status Request Entity Too Large
c_UnsupportedMediaTypeCode 415 status Unsupported Media Type
c_LockedCode 423 status Locked
c_CallTransactionDoesNotExistCode 481 status Call/Transaction Does Not Exist
c_NotImplementedCode 501 status Not Implemented
c_VariantNegotiatesCode 506 status Variant also negotiates
c_OKComment Comment for 200 status
c_BadRequestComment Comment for 400 Bad request
c_ForbiddenComment Comment for 403 Forbidden
c_RequestTimeoutComment Comment for 408 Request Time-out
c_RequestEntityTooLargeComment 413 status Request Entity Too Large
c_UnsupportedMediaTypeComment 415 status Unsupported Media Type
c_LockedComment 423 status Locked
c_CallTransactionDoesNotExistComment 481 status Call/Transaction Does Not Exist
c_NotImplementedComment 501 status Not Implemented
c_VariantNegotiatesComment 506 status Variant also negotiates
Templates Summary
mw_RequestLine_any Generic receive template for any Request start request line
mw_RequestLine_SEND_any Generic receive template for SEND start request line
mw_RequestLine_REPORT_any
mw_ResponseLine_any Generic receive template for RECEIVE start response line
mw_ResponseLine_success
mw_EndLine_any Receive template for any end line
mw_EndLine_noMore Receive template for SEND/RECEIVE end line, assuming that message are small enought to prevent chunk
m_msrpURIs_ToPath_Dummy Dummy send template for MsrpURI used by ToPath @ see RFC 4975 - Figure 2: Example MSRP Exchange
msrp://biloxi.

m_msrpURIs_FromPath_Dummy Dummy send template for MsrpURI used by FromPath @ see RFC 4975 - Figure 2: Example MSRP Exchange
msrp://atlanta.

m_msrpToPath_Dummy Dummy send template for ToPath @ see RFC 4975 - Figure 2: Example MSRP Exchange
msrp://atlanta.

m_msrpFromPath_Dummy Dummy send template for FromPath @ see RFC 4975 - Figure 2: Example MSRP Exchange
msrp://atlanta.

mw_toPath
mw_fromPath
m_msrpMessageID_Dummy Dummy send template for MessageID @ see RFC 4975 - Figure 2: Example MSRP Exchange
Message-ID: 87652491

m_msrpByteRange_Dummy Dummy send template for ByteRange @ see RFC 4975 - Figure 2: Example MSRP Exchange
Byte-Range: 1-25/25

mw_Headers_any
mw_Headers_toPath_FromPath
m_msrpContentStuff_Dummy Dummy send template for ContentStuff @ see RFC 4975 - Figure 2: Example MSRP Exchange
 Content-Type: text/plain
 
 
 Hey Bob, are you there?

mw_mediaType_any
mw_contentType_any
mw_contentStuff_any
mw_contentType
mw_msrpRequest_any Generic receive template for any request
m_msrpSend_Dummy Dummy send template for SEND request @ see RFC 4975 - Figure 2: Example MSRP Exchange
     MSRP a786hjs2 SEND
     To-Path: msrp://biloxi.

m_msrpReport_Dummy Dummy send template for SEND request @ see RFC 4975 - Figure 2: Example MSRP Exchange
      MSRP a786hjs2 REPORT
      To-Path: msrp://alicepc.

mw_msrpSEND_any Generic receive template for SEND request
mw_msrpSEND_toPath_fromPath_contentType
mw_msrpREPORT_success
m_msrpResponse_Dummy Dummy send template for RECEIVE response @ see RFC 4975 - Figure 2: Example MSRP Exchange
mw_msrpResponse_any
mw_msrpResponse_success
mw_msrpResponse_toPath_fromPath
mw_msrpResponse_toPath_fromPath_with_transferReports

Details

c_OKCode
const StatusCode c_OKCode := 200

Declared in group constants.codes

200 status OK

See also: RFC 4975 - Clause 10.1

c_BadRequestCode
const StatusCode c_BadRequestCode := 400

Declared in group constants.codes

400 status Bad request

See also: RFC 4975 - Clause 10.2

c_ForbiddenCode
const StatusCode c_ForbiddenCode := 403

Declared in group constants.codes

403 status Forbidden

See also: RFC 4975 - Clause 10.3

c_RequestTimeoutCode
const StatusCode c_RequestTimeoutCode := 408

Declared in group constants.codes

408 status Request Time-out

See also: RFC 4975 - Clause 10.4

c_RequestEntityTooLargeCode
const StatusCode c_RequestEntityTooLargeCode := 413

Declared in group constants.codes

413 status Request Entity Too Large

See also: RFC 4975 - Clause 10.5

c_UnsupportedMediaTypeCode
const StatusCode c_UnsupportedMediaTypeCode := 415

Declared in group constants.codes

415 status Unsupported Media Type

See also: RFC 4975 - Clause 10.6

c_LockedCode
const StatusCode c_LockedCode := 423

Declared in group constants.codes

423 status Locked

See also: RFC 4975 - Clause 10.7

c_CallTransactionDoesNotExistCode
const StatusCode c_CallTransactionDoesNotExistCode := 481

Declared in group constants.codes

481 status Call/Transaction Does Not Exist

See also: RFC 4975 - Clause 10.8

c_NotImplementedCode
const StatusCode c_NotImplementedCode := 501

Declared in group constants.codes

501 status Not Implemented

See also: RFC 4975 - Clause 10.9

c_VariantNegotiatesCode
const StatusCode c_VariantNegotiatesCode := 506

Declared in group constants.codes

506 status Variant also negotiates

See also: RFC 4975 - Clause 10.10

c_OKComment
const charstring c_OKComment := "OK"

Declared in group constants.comments

Comment for 200 status

See also: RFC 4975 - Clause 10.1

c_BadRequestComment
const charstring c_BadRequestComment := "Bad request"

Declared in group constants.comments

Comment for 400 Bad request

See also: RFC 4975 - Clause 10.2

c_ForbiddenComment
const charstring c_ForbiddenComment := "Forbidden"

Declared in group constants.comments

Comment for 403 Forbidden

See also: RFC 4975 - Clause 10.3

c_RequestTimeoutComment
const charstring c_RequestTimeoutComment := "Request Time-out"

Declared in group constants.comments

Comment for 408 Request Time-out

See also: RFC 4975 - Clause 10.4

c_RequestEntityTooLargeComment
const charstring c_RequestEntityTooLargeComment := "Request Entity Too Large"

Declared in group constants.comments

413 status Request Entity Too Large

See also: RFC 4975 - Clause 10.5

c_UnsupportedMediaTypeComment
const charstring c_UnsupportedMediaTypeComment := "Unsupported Media Type"

Declared in group constants.comments

415 status Unsupported Media Type

See also: RFC 4975 - Clause 10.6

c_LockedComment
const charstring c_LockedComment := "Locked"

Declared in group constants.comments

423 status Locked

See also: RFC 4975 - Clause 10.7

c_CallTransactionDoesNotExistComment
const charstring c_CallTransactionDoesNotExistComment := "Call/Transaction Does Not Exist"

Declared in group constants.comments

481 status Call/Transaction Does Not Exist

See also: RFC 4975 - Clause 10.8

c_NotImplementedComment
const charstring c_NotImplementedComment := "Not Implemented"

Declared in group constants.comments

501 status Not Implemented

See also: RFC 4975 - Clause 10.9

c_VariantNegotiatesComment
const charstring c_VariantNegotiatesComment := "Variant also negotiates"

Declared in group constants.comments

506 status Variant also negotiates

See also: RFC 4975 - Clause 10.10

mw_RequestLine_any
template MsrpRequestLine mw_RequestLine_any := {
tagMsrp := e_MSRP, 
transactionID := ?, 
method := ?
}

Declared in group delimiterLines

Generic receive template for any Request start request line

mw_RequestLine_SEND_any
template MsrpRequestLine mw_RequestLine_SEND_any := {
tagMsrp := e_MSRP, 
transactionID := ?, 
method := SEND_E
}

Declared in group delimiterLines

Generic receive template for SEND start request line

mw_RequestLine_REPORT_any
template MsrpRequestLine mw_RequestLine_REPORT_any := {
tagMsrp := e_MSRP, 
transactionID := ?, 
method := REPORT_E
}

Declared in group delimiterLines

mw_ResponseLine_any
template MsrpResponseLine mw_ResponseLine_any := {
tagMsrp := e_MSRP, 
transactionID := ?, 
statusCode := ?, 
comment := * 
}

Declared in group delimiterLines

Generic receive template for RECEIVE start response line

mw_ResponseLine_success
template MsrpResponseLine mw_ResponseLine_success 
modifies mw_ResponseLine_any := { 
statusCode := c_OKCode, 
comment := c_OKComment 
}

Declared in group delimiterLines

mw_EndLine_any
template EndLine mw_EndLine_any := {
transactionID := ?, 
continuationFlag := ?
}

Declared in group delimiterLines

Receive template for any end line

mw_EndLine_noMore
template EndLine mw_EndLine_noMore := {
transactionID := ?, 
continuationFlag := e_endMessage 
}

Declared in group delimiterLines

Receive template for SEND/RECEIVE end line, assuming that message are small enought to prevent chunk

m_msrpURIs_ToPath_Dummy
template (value) MsrpURI m_msrpURIs_ToPath_Dummy := { 
scheme := { 
scheme := e_SCHEME 
}, 
authority := {
host := "biloxi.example.com",
portNumber := 12763
}, 
sessionID := "kjhd37s2s20w2a", 
transport := "tcp", 
uriParams := omit 
}

Declared in group msrpAddressing

Dummy send template for MsrpURI used by ToPath @ see RFC 4975 - Figure 2: Example MSRP Exchange
msrp://biloxi.example.com:12763/kjhd37s2s20w2a;tcp


m_msrpURIs_FromPath_Dummy
template (value) MsrpURI m_msrpURIs_FromPath_Dummy := { 
scheme := { 
scheme := e_SCHEME 
}, 
authority := {
host := "atlanta.example.com",
portNumber := 7654
}, 
sessionID := "jshA7weztas", 
transport := "tcp", 
uriParams := omit 
}

Declared in group msrpAddressing

Dummy send template for MsrpURI used by FromPath @ see RFC 4975 - Figure 2: Example MSRP Exchange
msrp://atlanta.example.com:7654/jshA7weztas;tcp


m_msrpToPath_Dummy
template (value) ToPath m_msrpToPath_Dummy := { 
headerName := TO_PATH_E, 
msrpURIs := { 
m_msrpURIs_ToPath_Dummy
}
}

Declared in group msrpAddressing

Dummy send template for ToPath @ see RFC 4975 - Figure 2: Example MSRP Exchange
msrp://atlanta.example.com:7654/jshA7weztas;tcp


m_msrpFromPath_Dummy
template (value) FromPath m_msrpFromPath_Dummy := { 
headerName := FROM_PATH_E, 
msrpURIs := { 
m_msrpURIs_FromPath_Dummy
}
}

Declared in group msrpAddressing

Dummy send template for FromPath @ see RFC 4975 - Figure 2: Example MSRP Exchange
msrp://atlanta.example.com:7654/jshA7weztas;tcp


mw_toPath
template ToPath mw_toPath(in template (present) MsrpURI p_path) := {
headerName := TO_PATH_E,
msrpURIs := {
p_path
}
}

Declared in group msrpAddressing

Returns: ToPath -

Parameters:
mw_fromPath
template FromPath mw_fromPath(in template (present) MsrpURI p_path) := {
headerName := FROM_PATH_E,
msrpURIs := {
p_path
}
}

Declared in group msrpAddressing

Returns: FromPath -

Parameters:
m_msrpMessageID_Dummy
template (value) MessageID m_msrpMessageID_Dummy := {
headerName := MESSAGE_ID_E, 
messageId := "87652491" 
}

Declared in group msrpHeaders

Dummy send template for MessageID @ see RFC 4975 - Figure 2: Example MSRP Exchange
Message-ID: 87652491


m_msrpByteRange_Dummy
template (value) ByteRange m_msrpByteRange_Dummy := { 
headerName := BYTE_RANGE_E, 
startValue := 1, 
endValue := { intValue := 25 }, 
totalValue := { intValue := 25 } 
}

Declared in group msrpHeaders

Dummy send template for ByteRange @ see RFC 4975 - Figure 2: Example MSRP Exchange
Byte-Range: 1-25/25


mw_Headers_any
template Headers mw_Headers_any := {
toPath := ?, 
fromPath := ?, 
headers := * 
}

Declared in group msrpHeaders

mw_Headers_toPath_FromPath
template Headers mw_Headers_toPath_FromPath(
in template ToPath p_toPath,
in template FromPath p_fromPath
) modifies mw_Headers_any := {
toPath := p_toPath,
fromPath := p_fromPath
}

Declared in group msrpHeaders

Returns: Headers -

Parameters:
m_msrpContentStuff_Dummy
template (value) ContentStuff m_msrpContentStuff_Dummy := {
mimeHeaders := omit, 
contentType := { 
headerName := CONTENT_TYPE_E, 
mediaType := { 
mediaType := "text", 
subType := "plain", 
genParams := omit 
} 
}, 
data := char2oct("Hey Bob, are you there?")
}

Declared in group msrpContent

Dummy send template for ContentStuff @ see RFC 4975 - Figure 2: Example MSRP Exchange
 Content-Type: text/plain
 
 
 Hey Bob, are you there?
 


mw_mediaType_any
template MediaType mw_mediaType_any := {
mediaType := ?,
subType := ?,
genParams := *
}

Declared in group msrpContent

mw_contentType_any
template MsrpContentType mw_contentType_any := {
headerName := CONTENT_TYPE_E,
mediaType := mw_mediaType_any
}

Declared in group msrpContent

mw_contentStuff_any
template ContentStuff mw_contentStuff_any := {
mimeHeaders := *,
contentType := mw_contentType_any,
data := ?
}

Declared in group msrpContent

mw_contentType
template MsrpContentType mw_contentType( 
in charstring p_mediaType, 
in charstring p_subType
) modifies mw_contentType_any := { 
headerName := CONTENT_TYPE_E, 
mediaType := { 
mediaType := p_mediaType, 
subType := p_subType, 
genParams := * 
} 
}

Declared in group msrpContent

Returns: MsrpContentType -

Parameters:
mw_msrpRequest_any
template SEND_request mw_msrpRequest_any := {
startLine := mw_RequestLine_any,
headers := mw_Headers_any,
contentStuff := *,
endLine := mw_EndLine_any
}

Declared in group msrpRequest

Generic receive template for any request

m_msrpSend_Dummy
template (value) SEND_request m_msrpSend_Dummy := { 
startLine := { 
tagMsrp := e_MSRP, 
transactionID := "a786hjs2", 
method := SEND_E 
}, 
headers := { 
toPath := m_msrpToPath_Dummy, 
fromPath := m_msrpFromPath_Dummy, 
headers := { 
authenticationInfo := omit,
authorization := omit,
byteRange := m_msrpByteRange_Dummy,
expires := omit,
extHeaders := omit,
failureReport := omit,
maxExpires := omit,
messageID := m_msrpMessageID_Dummy, 
minExpires := omit,
status := omit,
successReport := omit,
usePath := omit,
wwwAuthenticate := omit
} 
}, 
contentStuff := m_msrpContentStuff_Dummy, 
endLine := { 
transactionID := "a786hjs2", 
continuationFlag := e_endMessage 
} 
}

Declared in group msrpRequest.msrpSEND

Dummy send template for SEND request @ see RFC 4975 - Figure 2: Example MSRP Exchange
     MSRP a786hjs2 SEND
     To-Path: msrp://biloxi.example.com:12763/kjhd37s2s20w2a;tcp
     From-Path: msrp://atlanta.example.com:7654/jshA7weztas;tcp
     Message-ID: 87652491
     Byte-Range: 1-25/25
     Content-Type: text/plain
  
     Hey Bob, are you there?
     -------a786hjs2$
  
     MSRP a786hjs2 200 OK
     To-Path: msrp://atlanta.example.com:7654/jshA7weztas;tcp
     From-Path: msrp://biloxi.example.com:12763/kjhd37s2s20w2a;tcp
     -------a786hjs2$
 


m_msrpReport_Dummy
template (value) SEND_request m_msrpReport_Dummy := { 
startLine := { 
tagMsrp := e_MSRP, 
transactionID := "a786hjs2", 
method := REPORT_E 
}, 
headers := { 
toPath := m_msrpToPath_Dummy, 
fromPath := m_msrpFromPath_Dummy, 
headers := { 
messageID := m_msrpMessageID_Dummy, 
byteRange := m_msrpByteRange_Dummy 
} 
}, 
contentStuff := m_msrpContentStuff_Dummy, 
endLine := { 
transactionID := "a786hjs2", 
continuationFlag := e_endMessage 
} 
}

Declared in group msrpRequest.msrpSEND

Dummy send template for SEND request @ see RFC 4975 - Figure 2: Example MSRP Exchange
      MSRP a786hjs2 REPORT
      To-Path: msrp://alicepc.example.com:7777/iau39soe2843z;tcp
      From-Path: msrp://bob.example.com:8888/9di4eae923wzd;tcp
      Message-ID: 87652491
      Byte-Range: 1-25/25
      Status: 000 200 OK
      ——-a786hjs2$
 


mw_msrpSEND_any
template SEND_request mw_msrpSEND_any := {
startLine := mw_RequestLine_SEND_any,
headers := mw_Headers_any,
contentStuff := mw_contentStuff_any,
endLine := mw_EndLine_noMore
}

Declared in group msrpRequest.msrpSEND

Generic receive template for SEND request

mw_msrpSEND_toPath_fromPath_contentType
template SEND_request mw_msrpSEND_toPath_fromPath_contentType( 
in template ToPath p_toPath,
in template FromPath p_fromPath,
in template MsrpContentType p_contentType
) modifies mw_msrpSEND_any := {
headers := mw_Headers_toPath_FromPath(
p_toPath, 
p_fromPath),
contentStuff := {
contentType := p_contentType
}
}

Declared in group msrpRequest.msrpSEND

Returns: SEND_request -

Parameters:
mw_msrpREPORT_success
template SEND_request mw_msrpREPORT_success modifies mw_msrpSEND_any := {
startLine := mw_RequestLine_REPORT_any,
headers := {
headers := {
status := {
headerName := STATUS_E, 
namespace := 0,
statusCode := c_OKCode, 
comment := c_OKComment
} 
}
} 
}

Declared in group msrpRequest.msrpSEND

m_msrpResponse_Dummy
template (value) RECEIVE_response m_msrpResponse_Dummy := {
startLine := { 
tagMsrp := e_MSRP, 
transactionID := "a786hjs2", 
statusCode := c_OKCode, 
comment := c_OKComment
}, 
headers := { 
toPath := m_msrpToPath_Dummy, 
fromPath := m_msrpFromPath_Dummy,
headers := { 
authenticationInfo := omit,
authorization := omit,
byteRange := omit,
expires := omit,
extHeaders := omit,
failureReport := omit,
maxExpires := omit,
messageID := m_msrpMessageID_Dummy,
minExpires := omit,
status := omit,
successReport := omit,
usePath := omit,
wwwAuthenticate := omit
} 
}, 
endLine := { 
transactionID := "a786hjs2", 
continuationFlag := e_endMessage 
} 
}

Declared in group msrpResponse

Dummy send template for RECEIVE response @ see RFC 4975 - Figure 2: Example MSRP Exchange

mw_msrpResponse_any
template RECEIVE_response mw_msrpResponse_any := {
startLine := mw_ResponseLine_any,
headers := mw_Headers_any,
endLine := mw_EndLine_noMore
}

Declared in group msrpResponse

mw_msrpResponse_success
template RECEIVE_response mw_msrpResponse_success 
modifies mw_msrpResponse_any := {
startLine := mw_ResponseLine_success
}

Declared in group msrpResponse

mw_msrpResponse_toPath_fromPath
template RECEIVE_response mw_msrpResponse_toPath_fromPath( 
in template ToPath p_toPath, 
in template FromPath p_fromPath 
) modifies mw_msrpResponse_success := {
headers := { 
toPath := p_toPath, 
fromPath := p_fromPath 
} 
}

Declared in group msrpResponse

Returns: RECEIVE_response -

Parameters:
mw_msrpResponse_toPath_fromPath_with_transferReports
template RECEIVE_response mw_msrpResponse_toPath_fromPath_with_transferReports( 
in template ToPath p_toPath, 
in template FromPath p_fromPath 
) modifies mw_msrpResponse_toPath_fromPath := {
headers := { 
headers := {
successReport := {
headerName := SUCCESS_REPORT_E,
reportStatus := e_YES
},
failureReport := {
headerName := FAILURE_REPORT_E,
reportStatus := e_NO
}
} 
} 
}

Declared in group msrpResponse

Returns: RECEIVE_response -

Parameters: