OVERVIEW   INDEX   DEPRECATED   HELP   CORRESPONDENCES  


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

Group msrpRequest

Declared in module LibMsrp_Templates

See also: RFC 4975 - Clause 7.1. Constructing Requests, RFC 4976 - Relay Extensions for the Message Session Relay Protocol (MSRP)
Subgroups: msrpAUTH, msrpSEND

Templates Summary
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

Details

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