SipMSRPApi

Version 60 (Adrian Georgescu, 05/03/2010 12:28 pm)

1 1 Adrian Georgescu
= MSRP API =
2 1 Adrian Georgescu
3 60 Adrian Georgescu
[[TOC(SipMiddlewareApi, SipConfigurationAPI, SipCoreApiDocumentation, SipMSRPApi, depth=3)]]
4 1 Adrian Georgescu
5 57 Adrian Georgescu
Message Session Relay Protocol (MSRP) is a protocol for transmitting a series of related Instant Messages in the context of a session. Message sessions are treated like any other media stream when set up via a rendezvous or session creation protocol such as the Session Initiation Protocol (SIP).  MSRP can be used for any application that requires a reliable stream of data, for example File Transfer or Desktop Sharing.
6 1 Adrian Georgescu
7 25 Adrian Georgescu
 * MSRP sessions are defined in [http://tools.ietf.org/html/rfc4975 RFC 4975]
8 54 Adrian Georgescu
 * MSRP relay extension for NAT traversal is defined in [http://tools.ietf.org/html/rfc4976 RFC 4976]
9 1 Adrian Georgescu
10 56 Adrian Georgescu
The MSRP protocol stack is implemented by [http://download.ag-projects.com/SipClient python-msrplib] package. 
11 4 Oliver Bril
12 33 Adrian Georgescu
{{{msrplib}}} is based upon [http://twistedmatrix.com twisted] and [http://download.ag-projects.com/SipClient/ eventlet] and provides a set of classes for establishing and managing MSRP connections.
13 1 Adrian Georgescu
14 28 Adrian Georgescu
The library consists of the following modules:
15 1 Adrian Georgescu
16 1 Adrian Georgescu
 '''msrplib.transport'''::
17 27 Adrian Georgescu
 Defines {{{MSRPTransport}}} class, which provides low level control over MSRP connections.
18 2 Redmine Admin
19 1 Adrian Georgescu
 '''msrplib.connect'''::
20 1 Adrian Georgescu
 Defines means to establish a connection, bind it, and provide an initialized {{{MSRPTransport}}} instance.
21 1 Adrian Georgescu
22 1 Adrian Georgescu
 '''msrplib.session'''::
23 1 Adrian Georgescu
 Defines {{{MSRPSession}}} class, which provides high level control over a MSRP connection.
24 1 Adrian Georgescu
25 1 Adrian Georgescu
 '''msrplib.protocol'''::
26 42 Luci Stanescu
 Provides representation and parsing of MSRP entities - chunks and MSRP URIs.  
27 1 Adrian Georgescu
28 48 Luci Stanescu
== URI ==
29 39 Luci Stanescu
30 44 Luci Stanescu
This class is implemented in the {{{msrplib.protocol}}} module and is used to represent an MSRP URI.
31 1 Adrian Georgescu
32 49 Adrian Georgescu
==== methods ====
33 1 Adrian Georgescu
34 39 Luci Stanescu
 '''!__init!__'''(''self'', '''host'''={{{None}}}, '''use_tls'''={{{False}}}, '''user'''={{{None}}}, '''port'''={{{None}}}, '''session_id'''={{{None}}}, '''parameters'''={{{None}}}, '''credentials'''={{{None}}})::
35 39 Luci Stanescu
  Constructs a new {{{URI}}}. All the arguments specified here are also attributes on the object. For more information on these attributes, see RFC4975.
36 39 Luci Stanescu
  [[BR]]''host'':[[BR]]
37 39 Luci Stanescu
  The hostname or IP address which forms the URI.
38 39 Luci Stanescu
  [[BR]]''use_tls'':[[BR]]
39 39 Luci Stanescu
  Whether this identifies an msrps or msrp URI.
40 39 Luci Stanescu
  [[BR]]''user'':[[BR]]
41 39 Luci Stanescu
  The user part of the URI.
42 39 Luci Stanescu
  [[BR]]''port'':[[BR]]
43 39 Luci Stanescu
  The port in the URI.
44 39 Luci Stanescu
  [[BR]]''session_id'':[[BR]]
45 39 Luci Stanescu
  The session identifier part of the URI.
46 1 Adrian Georgescu
  [[BR]]''parameters'':[[BR]]
47 39 Luci Stanescu
  A {{{dict}}} containing the parameters which will be appended to the URI.
48 39 Luci Stanescu
  [[BR]]''credentials'':[[BR]]
49 1 Adrian Georgescu
  A {{{gnutls.interfaces.twisted.X509Credentials}}} object which will be used if this identifies a TLS URI to authenticate to the other endpoint.
50 39 Luci Stanescu
51 48 Luci Stanescu
== MSRPRelaySettings ==
52 1 Adrian Georgescu
53 45 Luci Stanescu
This class is implemented in the {{{msrplib.connect}}} module and is used to specify the MSRP relay which will be used when connecting via a relay (using the {{{ConnectorRelay}}} or {{{AcceptorRelay}}} classes).
54 39 Luci Stanescu
55 49 Adrian Georgescu
==== methods ====
56 39 Luci Stanescu
57 39 Luci Stanescu
 '''!__init!__'''(''self'', '''domain''', '''username''', '''password''', '''host'''={{{None}}}, '''use_tls'''={{{False}}}, '''port'''={{{None}}}, '''credentials'''={{{None}}})::
58 39 Luci Stanescu
  Constructs a new {{{URI}}}. All the arguments specified here are also attributes on the object. For more information on these attributes, see RFC4975.
59 39 Luci Stanescu
  [[BR]]''domain'':[[BR]]
60 39 Luci Stanescu
  The DNS domain in which to search for a MSRP relay using SRV queries.
61 39 Luci Stanescu
  [[BR]]''username'':[[BR]]
62 39 Luci Stanescu
  The username which will be used to authenticate to the relay.
63 39 Luci Stanescu
  [[BR]]''password'':[[BR]]
64 39 Luci Stanescu
  The password which will be used to authenticate to the relay.
65 39 Luci Stanescu
  [[BR]]''host'':[[BR]]
66 39 Luci Stanescu
  The hostname or IP address of the MSRP relay.
67 1 Adrian Georgescu
  [[BR]]''use_tls'':[[BR]]
68 39 Luci Stanescu
  Whether this identifies an msrps or msrp URI.
69 39 Luci Stanescu
  [[BR]]''port'':[[BR]]
70 1 Adrian Georgescu
  The port in the URI.
71 39 Luci Stanescu
  [[BR]]''credentials'':[[BR]]
72 39 Luci Stanescu
  A {{{gnutls.interfaces.twisted.X509Credentials}}} object which will be used to authenticate to the relay if TLS is used.
73 39 Luci Stanescu
74 48 Luci Stanescu
== ConnectorDirect ==
75 39 Luci Stanescu
76 44 Luci Stanescu
This class is implemented in the {{{msrplib.connect}}} module and is used for outbound MSRP connections without a relay.
77 39 Luci Stanescu
78 49 Adrian Georgescu
==== methods ====
79 39 Luci Stanescu
80 39 Luci Stanescu
 '''!__init!__'''(''self'', '''loger'''={{{None}}})::
81 44 Luci Stanescu
 Constructs a new ConnectorDirect.
82 39 Luci Stanescu
 [[BR]]''logger'':[[BR]]
83 39 Luci Stanescu
 The logger which will be used for this MSRP connection. See the [wiki:SipMSRPApi#Logging Logging] section for more information.
84 39 Luci Stanescu
85 39 Luci Stanescu
 '''prepare'''(''self'', '''local_uri'''={{{None}}})::
86 39 Luci Stanescu
 This method returns a full local path - list of {{{protocol.URI}}} instances, suitable to be put in SDP {{{'a:path'}}} attribute.
87 39 Luci Stanescu
 [[BR]]''local_uri'':[[BR]]
88 39 Luci Stanescu
 This attribute will be used to construct the local path, but other than that it is not used anywhere else in case of the ConnectorDirect. If not provided, one
89 39 Luci Stanescu
 will be automatically generated
90 1 Adrian Georgescu
 
91 1 Adrian Georgescu
 '''complete'''(''self'', '''full_remote_path''')::
92 39 Luci Stanescu
 This method establishes the connection and binds it (sends an empty chunk to verify each other's From-Path and To-Path). It returns {{{transport.MSRPTransport}}} instance, ready to read and send chunks.
93 1 Adrian Georgescu
 [[BR]]''full_remote_path'':[[BR]]
94 39 Luci Stanescu
 A list of {{{protocol.URI}}} instances, obtained by parsing {{{'a:path'}}} put in SDP by the remote party.
95 1 Adrian Georgescu
96 39 Luci Stanescu
 '''cleanup'''(''self'')::
97 39 Luci Stanescu
 This method cleans up after {{{prepare()}}}; it should be called if {{{complete()}}} will not be called for whatever reason.
98 1 Adrian Georgescu
99 48 Luci Stanescu
== ConnectorRelay ==
100 1 Adrian Georgescu
101 44 Luci Stanescu
This class is implemented in the {{{msrplib.connect}}} module and is used for outbound MSRP connections using a relay.
102 1 Adrian Georgescu
103 49 Adrian Georgescu
==== methods ====
104 39 Luci Stanescu
105 39 Luci Stanescu
 '''!__init!__'''(''self'', '''relay''', '''loger'''={{{None}}})::
106 39 Luci Stanescu
 Constructs a new ConnectorRelay.
107 39 Luci Stanescu
 [[BR]]''relay'':[[BR]]
108 39 Luci Stanescu
 An instance of {{{MSRPRelaySettings}}} which identifies the relay which is to be used.
109 39 Luci Stanescu
 [[BR]]''logger'':[[BR]]
110 39 Luci Stanescu
 The logger which will be used for this MSRP connection. See the [wiki:SipMSRPApi#Logging Logging] section for more information.
111 39 Luci Stanescu
112 39 Luci Stanescu
 '''prepare'''(''self'', '''local_uri'''={{{None}}})::
113 39 Luci Stanescu
 This method returns a full local path - list of {{{protocol.URI}}} instances, suitable to be put in SDP {{{'a:path'}}} attribute.
114 39 Luci Stanescu
 [[BR]]''local_uri'':[[BR]]
115 1 Adrian Georgescu
 This attribute will be used to construct the local path, but other than that it is not used anywhere else in case of the ConnectorRelay. If not provided, one
116 39 Luci Stanescu
 will be automatically generated
117 39 Luci Stanescu
 
118 1 Adrian Georgescu
 '''complete'''(''self'', '''full_remote_path''')::
119 39 Luci Stanescu
 This method establishes the connection to the relay and binds it (sends an empty chunk to verify each other's From-Path and To-Path). It returns {{{transport.MSRPTransport}}} instance, ready to read and send chunks.
120 39 Luci Stanescu
 [[BR]]''full_remote_path'':[[BR]]
121 39 Luci Stanescu
 A list of {{{protocol.URI}}} instances, obtained by parsing {{{'a:path'}}} put in SDP by the remote party.
122 39 Luci Stanescu
123 1 Adrian Georgescu
 '''cleanup'''(''self'')::
124 39 Luci Stanescu
 This method cleans up after {{{prepare()}}}; it should be called if {{{complete()}}} will not be called for whatever reason.
125 1 Adrian Georgescu
126 48 Luci Stanescu
== AcceptorDirect ==
127 1 Adrian Georgescu
128 44 Luci Stanescu
This class is implemented in the {{{msrplib.connect}}} module and is used for inbound MSRP connections without using a relay.
129 1 Adrian Georgescu
130 49 Adrian Georgescu
==== methods ====
131 39 Luci Stanescu
132 39 Luci Stanescu
 '''!__init!__'''(''self'', '''loger'''={{{None}}})::
133 39 Luci Stanescu
  Constructs a new AcceptorDirect.
134 39 Luci Stanescu
 [[BR]]''logger'':[[BR]]
135 39 Luci Stanescu
 The logger which will be used for this MSRP connection. See the [wiki:SipMSRPApi#Logging Logging] section for more information.
136 39 Luci Stanescu
137 39 Luci Stanescu
 '''prepare'''(''self'', '''local_uri'''={{{None}}})::
138 1 Adrian Georgescu
 This method starts listening on a socket identified by the parameters in the {{{local_uri}}} argument. It returns a full local path - list of {{{protocol.URI}}} instances, suitable to be put in SDP {{{'a:path'}}} attribute.
139 39 Luci Stanescu
 [[BR]]''local_uri'':[[BR]]
140 39 Luci Stanescu
 This attribute will be used to construct the local path and to listen for incomming connections. If not provided, one
141 52 Luci Stanescu
 will be automatically generated. Note that the object may be changed in place: for example, if the port specified is 0,
142 52 Luci Stanescu
 a random one will be selected and the object will be updated accordingly.
143 39 Luci Stanescu
 
144 39 Luci Stanescu
 '''complete'''(''self'', '''full_remote_path''')::
145 39 Luci Stanescu
 This method waits for an incoming connection and a chunk sent by the other party. It returns {{{transport.MSRPTransport}}} instance, ready to read and send chunks.
146 39 Luci Stanescu
 [[BR]]''full_remote_path'':[[BR]]
147 39 Luci Stanescu
 A list of {{{protocol.URI}}} instances, obtained by parsing {{{'a:path'}}} put in SDP by the remote party. This is checked agains the From-Path header in the binding chunk.
148 39 Luci Stanescu
149 39 Luci Stanescu
 '''cleanup'''(''self'')::
150 39 Luci Stanescu
 This method cleans up after {{{prepare()}}}; it should be called if {{{complete()}}} will not be called for whatever reason.
151 39 Luci Stanescu
152 48 Luci Stanescu
== AcceptorRelay ==
153 39 Luci Stanescu
154 44 Luci Stanescu
This class is implemented in the {{{msrplib.connect}}} module and is used for inbound MSRP connections using a relay.
155 39 Luci Stanescu
156 49 Adrian Georgescu
==== methods ====
157 39 Luci Stanescu
158 39 Luci Stanescu
 '''!__init!__'''(''self'', '''relay''', '''loger'''={{{None}}})::
159 39 Luci Stanescu
 Constructs a new AcceptorRelay.
160 39 Luci Stanescu
 [[BR]]''relay'':[[BR]]
161 39 Luci Stanescu
 An instance of {{{MSRPRelaySettings}}} which identifies the relay which is to be used.
162 39 Luci Stanescu
 [[BR]]''logger'':[[BR]]
163 1 Adrian Georgescu
 The logger which will be used for this MSRP connection. See the [wiki:SipMSRPApi#Logging Logging] section for more information.
164 39 Luci Stanescu
165 39 Luci Stanescu
 '''prepare'''(''self'', '''local_uri'''={{{None}}})::
166 1 Adrian Georgescu
 This method connects to the relay specified in {{{__init__}}}. It returns a full local path - list of {{{protocol.URI}}} instances, suitable to be put in SDP {{{'a:path'}}} attribute.
167 39 Luci Stanescu
 [[BR]]''local_uri'':[[BR]]
168 39 Luci Stanescu
 This attribute will be used to construct the local path. If not provided, one will be automatically generated
169 39 Luci Stanescu
 
170 39 Luci Stanescu
 '''complete'''(''self'', '''full_remote_path''')::
171 39 Luci Stanescu
 This method waits for an incoming chunk sent by the other party. It returns {{{transport.MSRPTransport}}} instance, ready to read and send chunks.
172 39 Luci Stanescu
 [[BR]]''full_remote_path'':[[BR]]
173 39 Luci Stanescu
 A list of {{{protocol.URI}}} instances, obtained by parsing {{{'a:path'}}} put in SDP by the remote party. This is checked agains the From-Path header in the binding chunk.
174 39 Luci Stanescu
175 39 Luci Stanescu
 '''cleanup'''(''self'')::
176 39 Luci Stanescu
 This method cleans up after {{{prepare()}}}; it should be called if {{{complete()}}} will not be called for whatever reason.
177 39 Luci Stanescu
178 53 Luci Stanescu
179 14 Oliver Bril
== MSRPTransport ==
180 1 Adrian Georgescu
181 1 Adrian Georgescu
This class is implemented in the {{{msrplib.transport}}} module and provies low level access to the MSRP connection. This class should not be constructed directly, but rather its intances should be obtained by using the various connector/acceptor classes documented above.
182 1 Adrian Georgescu
183 1 Adrian Georgescu
==== methods ====
184 1 Adrian Georgescu
185 1 Adrian Georgescu
 '''make_chunk'''(''self'', '''transaction_id'''={{{None}}}, '''method'''={{{'SEND'}}}, '''code'''={{{None}}}, '''comment'''={{{None}}}, '''data'''={{{''}}}, '''contflag'''={{{None}}}, '''start'''={{{1}}}, '''end'''={{{None}}}, '''length'''={{{None}}}, '''message_id'''={{{None}}})::
186 1 Adrian Georgescu
 Creates a new chunk ({{{protocol.MSRPData}}} instance), which is either an MSRP request or a response. Proper {{{From-Path}}}, {{{To-Path}}}, {{{Byte-Range}}} and {{{Message-ID}}} headers are added based on MSRPTransport's state and the parameters provided. Use ''data'' for payload, and ''start''/''end''/''length'' to generate the {{{Byte-Range}}} header.
187 1 Adrian Georgescu
 [[BR]]''transaction_id'':[[BR]]
188 1 Adrian Georgescu
 The transaction id which will be put in the chunk. If it is not provided, one will be randomly generated.
189 1 Adrian Georgescu
 [[BR]]''method'':[[BR]]
190 1 Adrian Georgescu
 The method of the new MSRP request, or {{{None}}} if a response is required.
191 1 Adrian Georgescu
 [[BR]]''code'':[[BR]]
192 1 Adrian Georgescu
 The code of the new MSRP response, or {{{None}}} if a request is required.
193 1 Adrian Georgescu
 [[BR]]''code'':[[BR]]
194 1 Adrian Georgescu
 The comment of the new MSRP response, or {{{None}}} if a request is required or a comment on the response is not.
195 1 Adrian Georgescu
 [[BR]]''data'':[[BR]]
196 1 Adrian Georgescu
 The payload of the new chunk, or an empty string if no payload is required.
197 1 Adrian Georgescu
 [[BR]]''contflag'':[[BR]]
198 1 Adrian Georgescu
 MSRP chunk's continuation flag ({{{'$'}}}, {{{'+'}}} or {{{'#'}}}). Default is {{{'$'}}} for a full message, unless a partial {{{SEND}}} chunk required, in which case it should be set to {{{'+'}}}. If {{{None}}} is provided, either {{{'$'}}} or {{{'+'}}} will be used depending on whether this chunk seems to carry the last part of the message data.
199 1 Adrian Georgescu
 [[BR]]''start'':[[BR]]
200 1 Adrian Georgescu
 The first byte's index within the whole message payload this chunk will carry as its own payload.
201 1 Adrian Georgescu
 [[BR]]''end'':[[BR]]
202 1 Adrian Georgescu
 The last byte's index within the whole message payload this chunk will carry as its own payload. Note that this is an inclusive index. If this is not provided, it's computed based on the number of bytes in data and {{{start}}}.
203 1 Adrian Georgescu
 [[BR]]''length'':[[BR]]
204 1 Adrian Georgescu
 The total number of bytes of the whole message payload. If this is not provided, it is computed as if this chunk carries that last part of the message payload.
205 1 Adrian Georgescu
 [[BR]]''message_id'':[[BR]]
206 1 Adrian Georgescu
 The ID of the message this chunk is part of. If it is not provided, one will be randomly generated.
207 1 Adrian Georgescu
208 1 Adrian Georgescu
 '''write_chunk'''(''self'', '''chunk''', '''wait'''={{{True}}})::
209 1 Adrian Georgescu
 Writes the chunk provided to the underlying socket.
210 1 Adrian Georgescu
 [[BR]]''chunk'':[[BR]]
211 1 Adrian Georgescu
 The chunk which is to be written, an instance of {{{MSRPData}}}.
212 1 Adrian Georgescu
 [[BR]]''wait'':[[BR]]
213 1 Adrian Georgescu
 If {{{True}}}, waits for the operation to complete.
214 1 Adrian Georgescu
215 1 Adrian Georgescu
 '''write_response'''(''self'', '''chunk''', '''code''', '''comment''', '''wait'''={{{True}}}):
216 1 Adrian Georgescu
 Creates a response which is suitable as a reply to the specified chunk and writes it to the underlying socket.
217 1 Adrian Georgescu
 [[BR]]''chunk'':[[BR]]
218 1 Adrian Georgescu
 The chunk for which to create a response.
219 1 Adrian Georgescu
 [[BR]]''code'':[[BR]]
220 1 Adrian Georgescu
 The status code of the response which is to be created.
221 1 Adrian Georgescu
 [[BR]]''comment'':[[BR]]
222 1 Adrian Georgescu
 The comment of the response which is to be created.
223 1 Adrian Georgescu
 [[BR]]''wait'':[[BR]]
224 1 Adrian Georgescu
 If {{{True}}}, waits for the operation to complete.
225 1 Adrian Georgescu
226 1 Adrian Georgescu
 '''read_chunk'''(''self'', '''size'''={{{None}}})::
227 1 Adrian Georgescu
 Waits for a new chunk and returns it.
228 1 Adrian Georgescu
 If there was an error, closes the connection and raises {{{ChunkParseError}}}.
229 1 Adrian Georgescu
230 1 Adrian Georgescu
 In case of unintelligible input, loses the connection and returns {{{None}}}.
231 1 Adrian Georgescu
 When the connection is closed, raises the reason of the closure (e.g. {{{ConnectionDone}}}).
232 1 Adrian Georgescu
233 1 Adrian Georgescu
 If the data already read exceeds ''size'', stops reading the data and returns
234 1 Adrian Georgescu
 a "virtual" chunk, i.e. the one that does not actually correspond the the real
235 1 Adrian Georgescu
 MSRP chunk. Such chunks have Byte-Range header changed to match the number of
236 1 Adrian Georgescu
 bytes read and continuation that is {{{'+'}}}; they also possess {{{segment}}} attribute,
237 1 Adrian Georgescu
 an integer, starting with 1 and increasing with every new segment of the chunk.
238 1 Adrian Georgescu
239 1 Adrian Georgescu
 Note, that ''size'' only hints when to interrupt the segment but does not affect
240 1 Adrian Georgescu
 how the data is read from socket. You may have segments bigger than ''size'' and it's
241 1 Adrian Georgescu
 legal to set ''size'' to zero (which would mean return a chunk as long as you get
242 1 Adrian Georgescu
 some data, regardless how small).
243 1 Adrian Georgescu
 
244 1 Adrian Georgescu
 [[BR]]''size'':[[BR]]
245 1 Adrian Georgescu
 The hint towards how much to read from the socket. If the data already read is larger, then all the data will be returned, even if it exceeds {{{size}}} bytes.
246 1 Adrian Georgescu
247 1 Adrian Georgescu
 '''check_incoming_SEND_chunk'''(''self'', '''chunk''')::
248 1 Adrian Georgescu
 Checks the 'To-Path' and 'From-Path' of the incoming SEND chunk.
249 1 Adrian Georgescu
 Returns None is the paths are valid for this connection.
250 1 Adrian Georgescu
 If an error is detected an MSRPError is created and returned.
251 58 Adrian Georgescu
252 58 Adrian Georgescu
== MSRPData ==
253 58 Adrian Georgescu
254 58 Adrian Georgescu
This class is implemented in the {{{msrplib.protocol}}} module and represents an MSRP chunk, either a request or a response.
255 58 Adrian Georgescu
256 58 Adrian Georgescu
==== attributes ====
257 58 Adrian Georgescu
258 58 Adrian Georgescu
 The following attributes are read-only.
259 58 Adrian Georgescu
260 58 Adrian Georgescu
 '''content_type'''::
261 58 Adrian Georgescu
  The MIME type of the payload carried by this chunk, which is stored in the Content-Type header.
262 58 Adrian Georgescu
263 58 Adrian Georgescu
 '''message_id'''::
264 58 Adrian Georgescu
  The ID of the message this chunk is part of, which is stored in the Message-ID header.
265 58 Adrian Georgescu
266 58 Adrian Georgescu
 '''byte_range'''::
267 58 Adrian Georgescu
  A 3-tuple containing the start, end and length values (in this order) from the Byte-Range header.
268 58 Adrian Georgescu
269 58 Adrian Georgescu
 '''status'''::
270 58 Adrian Georgescu
  The value of the Status header.
271 58 Adrian Georgescu
272 58 Adrian Georgescu
 '''failure_report'''::
273 58 Adrian Georgescu
  The value of the Failure-Report header, whether it exists or it is implied; one of {{{'yes'}}}, {{{'no'}}}, {{{'partial'}}}.
274 58 Adrian Georgescu
275 58 Adrian Georgescu
 '''success_report'''::
276 58 Adrian Georgescu
  The value of the Success-Report header, whether it exists or it is implied; one of {{{'yes'}}} or {{{'no'}}}.
277 58 Adrian Georgescu
278 58 Adrian Georgescu
 '''size'''::
279 58 Adrian Georgescu
  The size of the payload of this chunk, in bytes.
280 58 Adrian Georgescu
281 58 Adrian Georgescu
==== methods ====
282 58 Adrian Georgescu
283 58 Adrian Georgescu
 '''!__init!__'''(''self'', '''transaction_id''', '''method'''={{{None}}}, '''code'''={{{None}}}, '''comment'''={{{None}}}, '''headers'''={{{None}}}, '''data'''={{{''}}}, '''contflag'''={{{'$'}}})::
284 58 Adrian Georgescu
  Initializes a new MSRPData instance. All the arguments are also available as attributes.
285 58 Adrian Georgescu
  [[BR]]''transaction_id'':[[BR]]
286 58 Adrian Georgescu
  The transaction identified of this chunk.
287 58 Adrian Georgescu
  [[BR]]''method'':[[BR]]
288 58 Adrian Georgescu
  The method of this chunk if it a request and {{{None}}} if it is a response.
289 58 Adrian Georgescu
  [[BR]]''code'':[[BR]]
290 58 Adrian Georgescu
  The status code of this chunk if it is a response and {{{None}}} if it is a request.
291 58 Adrian Georgescu
  [[BR]]''comment'':[[BR]]
292 58 Adrian Georgescu
  The comment of this chunk if it is a response and {{{None}}} if it is a request.
293 58 Adrian Georgescu
  [[BR]]''headers'':[[BR]]
294 58 Adrian Georgescu
  A dict containing the headers which are to be added to this chunk, or {{{None}}} if no headers are to be added.
295 58 Adrian Georgescu
  [[BR]]''data'':[[BR]]
296 58 Adrian Georgescu
  The payload of this chunk, or an empty string if no payload is to be added.
297 58 Adrian Georgescu
  [[BR]]''contflag'':[[BR]]
298 58 Adrian Georgescu
  The MSRP continuation flag of this chunk, one of {{{'$'}}}, {{{'#'}}} or {{{'+'}}}.
299 58 Adrian Georgescu
300 58 Adrian Georgescu
 '''copy'''(''self'')::
301 58 Adrian Georgescu
  Returns a new MSRPData instance with exactly the same attributes as this object.
302 58 Adrian Georgescu
303 58 Adrian Georgescu
 '''add_header'''(''self'', '''header''')::
304 58 Adrian Georgescu
  Add a MSRP header to this chunk.
305 58 Adrian Georgescu
  [[BR]]''header'':[[BR]]
306 58 Adrian Georgescu
  The header object which is to be added to this chunk.
307 58 Adrian Georgescu
308 58 Adrian Georgescu
 '''verify_headers'''(''self'')::
309 58 Adrian Georgescu
  Verifies that the chunk contains a To-Path and a From-Path header and that all the headers are valid.
310 58 Adrian Georgescu
311 58 Adrian Georgescu
 '''encode_start'''(''self'')::
312 58 Adrian Georgescu
  Returns a string containing the MSRP header of this chunk.
313 58 Adrian Georgescu
314 58 Adrian Georgescu
 '''encode_end'''(''self'', '''continuation''')::
315 58 Adrian Georgescu
  Returns a string containing the MSRP end line of this chunk: 7 commas followed by the transaction identifier and the continuation flag specified.
316 58 Adrian Georgescu
  [[BR]]''continuation'':[[BR]]
317 58 Adrian Georgescu
  The continuation flag which is to be used in the end line.
318 58 Adrian Georgescu
319 58 Adrian Georgescu
 '''encode'''(''self''):
320 58 Adrian Georgescu
  Returns a string containing the whole of this MSRP chunk.
321 58 Adrian Georgescu
322 1 Adrian Georgescu
323 51 Luci Stanescu
== OutgoingFile ==
324 51 Luci Stanescu
325 51 Luci Stanescu
This class is implemented in the {{{msrplib.session}}} module and represents a file which is to be sent via MSRP.
326 51 Luci Stanescu
327 51 Luci Stanescu
==== attributes ====
328 51 Luci Stanescu
329 51 Luci Stanescu
 '''headers'''::
330 51 Luci Stanescu
  A dict which maps header names to header objects. These headers will be sent in the MSRP message used to send the file.
331 51 Luci Stanescu
332 51 Luci Stanescu
==== methods ====
333 51 Luci Stanescu
334 51 Luci Stanescu
 '''!__init!__'''(''self'', '''fileobj''', '''size''', '''content_type'''={{{None}}}, '''position'''={{{0}}}, '''message_id'''={{{None}}})::
335 51 Luci Stanescu
  Initializes a new OutgoingFile using the specified file object. All arguments are available as attributes, except for {{{content_type}}} which will be part of the {{{headers}}} attribute.
336 51 Luci Stanescu
  [[BR]]''fileobj'':[[BR]]
337 51 Luci Stanescu
  A file-like object which will be used for reading the data to be sent.
338 51 Luci Stanescu
  [[BR]]''size'':[[BR]]
339 51 Luci Stanescu
  The size of the whole file.
340 51 Luci Stanescu
  [[BR]]''content_type'':[[BR]]
341 51 Luci Stanescu
  The MIME type associated with the file's data. If provided, it will be added as a Content-Type header.
342 51 Luci Stanescu
  [[BR]]''position'':[[BR]]
343 51 Luci Stanescu
  The position within the file from which data will be sent. The file object must already be seeked to this position.
344 51 Luci Stanescu
  [[BR]]''message_id'':[[BR]]
345 51 Luci Stanescu
  The message ID which will be used for sending this file.
346 1 Adrian Georgescu
347 1 Adrian Georgescu
== MSRPSession ==
348 1 Adrian Georgescu
349 1 Adrian Georgescu
This class is implemented in the {{{msrplib.session}}} module and provides a high level API for MSRP sessions.
350 1 Adrian Georgescu
351 1 Adrian Georgescu
==== methods ====
352 1 Adrian Georgescu
353 1 Adrian Georgescu
 '''!__init!__'''(''self'', '''msrptransport''', '''accept_types'''={{{['*']}}}, '''on_incoming_cb'''={{{None}}})::
354 1 Adrian Georgescu
 Initializes MSRPSession instance over the specified transport. The incoming chunks are reported through the ''on_incoming_cb'' callback.
355 1 Adrian Georgescu
 [[BR]]''msrptransport'':[[BR]]
356 1 Adrian Georgescu
 An instance of {{{MSRPTransport}}} over which this session will operate.
357 1 Adrian Georgescu
 [[BR]]''accept_types'':[[BR]]
358 1 Adrian Georgescu
 A list of MIME types which are acceptable over this session. If data is received with a Content-Type header which doesn't match this list, a negative response is sent back and the application does not get the received data. The special strings {{{'*'}}} and {{{'<type>/*'}}} can be used to match multiple MIME types.
359 1 Adrian Georgescu
 [[BR]]''on_incoming_cb'':[[BR]]
360 1 Adrian Georgescu
 A function which receives two arguments, both optional with default values of {{{None}}}: ''chunk'' and ''error''. This will be called when a new chunk is received.
361 1 Adrian Georgescu
362 1 Adrian Georgescu
 '''send_chunk'''(''self'', '''chunk''', '''response_cb'''={{{None}}})::
363 1 Adrian Georgescu
 Sends the specified chunk and reports the result via the ''response_cb'' callback.
364 1 Adrian Georgescu
365 1 Adrian Georgescu
 When ''response_cb'' argument is present, it will be used to report
366 1 Adrian Georgescu
 the transaction response to the caller. When a response is received or generated
367 1 Adrian Georgescu
 locally, ''response_cb'' is called with one argument. The function must do something
368 1 Adrian Georgescu
 quickly and must not block, because otherwise it would block the reader greenlet.
369 1 Adrian Georgescu
370 1 Adrian Georgescu
 If no response was received after {{{RESPONSE_TIMEOUT}}} seconds,
371 1 Adrian Georgescu
 * 408 response is generated if Failure-Report was {{{'yes'}}} or absent
372 1 Adrian Georgescu
 * 200 response is generated if Failure-Report was {{{'partial'}}} or {{{'no'}}}
373 1 Adrian Georgescu
374 1 Adrian Georgescu
 Note that it's rather wasteful to provide ''response_cb'' argument other than {{{None}}}
375 1 Adrian Georgescu
 for chunks with Failure-Report='no' since it will always fire 30 seconds later
376 1 Adrian Georgescu
 with 200 result (unless the other party is broken and ignores Failure-Report header)
377 1 Adrian Georgescu
378 1 Adrian Georgescu
 If sending is not possible, {{{MSRPSessionError}}} is raised.
379 1 Adrian Georgescu
380 1 Adrian Georgescu
 [[BR]]''chunk'':[[BR]]
381 1 Adrian Georgescu
 The chunk which is to be sent. It must be an instance of {{{MSRPData}}} which represents a request.
382 1 Adrian Georgescu
 [[BR]]''response_cb'':[[BR]]
383 1 Adrian Georgescu
 A function receiving a single argument which will be the response received for the sent chunk.
384 1 Adrian Georgescu
385 1 Adrian Georgescu
 '''deliver_chunk'''(''self'', '''chunk''', '''event'''={{{None}}})::
386 1 Adrian Georgescu
 Sends the specified chunk and waits for the transaction response (if Failure-Report header is not {{{'no'}}}).
387 1 Adrian Georgescu
 Returns the transaction response if it's a success or raise {{{MSRPTransactionError}}} if it's not.
388 1 Adrian Georgescu
389 1 Adrian Georgescu
 If chunk's Failure-Report is {{{'no'}}}, returns {{{None}}} immediately.
390 1 Adrian Georgescu
391 1 Adrian Georgescu
 [[BR]]''chunk'':[[BR]]
392 1 Adrian Georgescu
 The chunk which is to be sent. It must be an intance of {{{MSRPData}}} which represents a request.
393 1 Adrian Georgescu
 [[BR]]''event'':[[BR]]
394 1 Adrian Georgescu
 The {{{eventlet.coros.event}}} object which will be used to wait for a response. It's send method will be called when a response is received. If it is not provided, one will be constructed automatically and used.
395 1 Adrian Georgescu
 
396 1 Adrian Georgescu
 '''send_file'''(''self'', '''outgoing_file''')::
397 1 Adrian Georgescu
 Adds the specified file to the queue of files to be sent. The method returns immediately.
398 1 Adrian Georgescu
 [[BR]]''outgoing_file'':[[BR]]
399 1 Adrian Georgescu
 An instance of {{{OutgoingFile}}} which represents the file to be sent.
400 1 Adrian Georgescu
401 1 Adrian Georgescu
 '''shutdown'''(''self'', '''sync'''={{{True}}})::
402 1 Adrian Georgescu
 Sends the messages already in queue then closes the connection.
403 1 Adrian Georgescu
404 1 Adrian Georgescu
== MSRPServer ==
405 1 Adrian Georgescu
406 1 Adrian Georgescu
This class is implemented in the {{{msrplib.connect}}} module.
407 1 Adrian Georgescu
    
408 1 Adrian Georgescu
MSRPServer solves the problem with AcceptorDirect: concurrent using of 2
409 1 Adrian Georgescu
or more AcceptorDirect instances on the same non-zero port is not possible.
410 1 Adrian Georgescu
If you initialize() those instances, one after another, one will listen on
411 1 Adrian Georgescu
the socket and another will get BindError.
412 1 Adrian Georgescu
413 1 Adrian Georgescu
MSRPServer avoids the problem by sharing the listening socket between multiple connections.
414 1 Adrian Georgescu
It has a slightly different interface from AcceptorDirect, so it cannot be considered a drop-in
415 1 Adrian Georgescu
replacement.
416 1 Adrian Georgescu
417 1 Adrian Georgescu
It manages the listening sockets and binds incoming requests.
418 1 Adrian Georgescu
419 1 Adrian Georgescu
==== methods ====
420 1 Adrian Georgescu
421 1 Adrian Georgescu
 '''!__init!__'''(''self'', '''logger''')::
422 1 Adrian Georgescu
 Constructs a new MSRPServer which will be using the specifed logger for its connections.
423 1 Adrian Georgescu
 [[BR]]''logger'':[[BR]]
424 1 Adrian Georgescu
 The default logger which will be used for this object's MSRP connections. See the [wiki:SipMSRPApi#Logging Logging] section for more information.
425 1 Adrian Georgescu
426 1 Adrian Georgescu
 '''prepare'''(''self'', ''local_uri''={{{None}}}, ''logger''={{{None}}})::
427 1 Adrian Georgescu
 Starts a listening port specified by ''local_uri'' if there isn't one on that port/interface already.
428 1 Adrian Georgescu
 Adds ''local_uri'' to the list of expected URIs, so that incoming connections featuring this URI won't be rejected.
429 1 Adrian Georgescu
 If ''logger'' is provided, it uses it for this connection instead of the one specified in {{{__init___}}}.
430 1 Adrian Georgescu
 [[BR]]''local_uri'':[[BR]]
431 1 Adrian Georgescu
 The URI which will be added to the list of expected URIs. Connections from this URI will be accepted.
432 1 Adrian Georgescu
 [[BR]]''logger'':[[BR]]
433 1 Adrian Georgescu
 The logger which will be used for connections from the specified URI. See the [wiki:SipMSRPApi#Logging Logging] section for more information.
434 1 Adrian Georgescu
435 1 Adrian Georgescu
 '''complete'''(''self'', ''full_remote_path'')::
436 1 Adrian Georgescu
 Waits until one of the incoming connections binds using the provided ''full_remote_path''.
437 1 Adrian Georgescu
 Returns the connected and bound {{{MSRPTransport}}} instance.
438 1 Adrian Georgescu
 If no such binding was made within {{{MSRPBindSessionTimeout.seconds}}}, {{{MSRPBindSessionTimeout}}} is raised.
439 1 Adrian Georgescu
 [[BR]]''full_remote_path'':[[BR]]
440 1 Adrian Georgescu
 A list of {{{protocol.URI}}} instances, obtained by parsing {{{'a:path'}}} put in SDP by the remote party.
441 1 Adrian Georgescu
442 1 Adrian Georgescu
 '''cleanup'''(''self'', ''local_uri'')::
443 1 Adrian Georgescu
 Removes ''local_uri'' from the list of expected URIs.
444 1 Adrian Georgescu
 [[BR]]''local_uri'':[[BR]]
445 1 Adrian Georgescu
 The URI which is to be removed from the list of expected URIs.
446 59 Adrian Georgescu
447 59 Adrian Georgescu
== Headers ==
448 59 Adrian Georgescu
449 59 Adrian Georgescu
The MSRP headers are represented using objects from the {{{msrplib.protocol module}}}. All MSRP header object provide three properties:
450 59 Adrian Georgescu
 ''name'':[[BR]]
451 59 Adrian Georgescu
 The name of the header, as it appears in MSRP chunks.
452 59 Adrian Georgescu
 [[BR]]''encode'':[[BR]]
453 59 Adrian Georgescu
 The MSRP encoded header value, as it appears in MSRP chunks.
454 59 Adrian Georgescu
 [[BR]]''decode'':[[BR]]
455 59 Adrian Georgescu
 The high-level object representing the header value.
456 59 Adrian Georgescu
457 59 Adrian Georgescu
All headers can be constructed by passing either the encoded or decoded objects to {{{__init__}}}. The following headers are provided:
458 59 Adrian Georgescu
459 59 Adrian Georgescu
=== ToPathHeader ===
460 59 Adrian Georgescu
461 59 Adrian Georgescu
The name of the header is {{{'To-Path'}}} and the decoded value is a deque of {{{URI}}} objects.
462 59 Adrian Georgescu
463 59 Adrian Georgescu
=== FromPathHeader ===
464 59 Adrian Georgescu
465 59 Adrian Georgescu
The name of the header is {{{'From-Path'}}} and the decoded value is a deque of {{{URI}}} objects.
466 59 Adrian Georgescu
467 59 Adrian Georgescu
=== MessageIDHeader ===
468 59 Adrian Georgescu
469 59 Adrian Georgescu
The name of the header is {{{'Message-ID'}}} and the decoded value is the string containing the message ID.
470 59 Adrian Georgescu
471 59 Adrian Georgescu
=== SuccessReportHeader ===
472 59 Adrian Georgescu
473 59 Adrian Georgescu
The name of the header is {{{'Success-Report'}}} and the decoded value is one of {{{'yes'}}} or {{{'no'}}}.
474 59 Adrian Georgescu
475 59 Adrian Georgescu
=== FailureReportHeader ===
476 59 Adrian Georgescu
477 59 Adrian Georgescu
The name of the header is {{{'Failure-Report'}}} and the decoded value is one of {{{'yes'}}}, {{{'partial'}}} or {{{'no'}}}.
478 59 Adrian Georgescu
479 59 Adrian Georgescu
=== ByteRangeHeader ===
480 59 Adrian Georgescu
481 59 Adrian Georgescu
The name of the header is {{{'Byte-Range'}}} and the decoded value is a 3-tuple containing the start, end and length values.
482 59 Adrian Georgescu
483 59 Adrian Georgescu
==== attributes ====
484 59 Adrian Georgescu
485 59 Adrian Georgescu
 '''fro'''::
486 59 Adrian Georgescu
  The start value of the header: the index within the whole message payload where a chunk's payload starts.
487 59 Adrian Georgescu
 '''end'''::
488 59 Adrian Georgescu
  The end value of the header: the index within the whole message payload where a chunk's payload ends. Note that this index is inclusive.
489 59 Adrian Georgescu
 '''length'''::
490 59 Adrian Georgescu
  The total size of the message payload.
491 59 Adrian Georgescu
492 59 Adrian Georgescu
=== StatusHeader ===
493 59 Adrian Georgescu
494 59 Adrian Georgescu
The name of the header is {{{'Status'}}} and the decoded value is a 2-tuple containing the status code and comment.
495 59 Adrian Georgescu
496 59 Adrian Georgescu
==== attributes ====
497 59 Adrian Georgescu
498 59 Adrian Georgescu
 '''code'''::
499 59 Adrian Georgescu
  The code component of the header.
500 59 Adrian Georgescu
 '''comment'''::
501 59 Adrian Georgescu
  The comment component of the header.
502 59 Adrian Georgescu
503 59 Adrian Georgescu
=== ExpiresHeader ===
504 59 Adrian Georgescu
505 59 Adrian Georgescu
The name of the header is {{{'Expires'}}} and the decoded value is an integer.
506 59 Adrian Georgescu
507 59 Adrian Georgescu
=== MinExpiresHeader ===
508 59 Adrian Georgescu
509 59 Adrian Georgescu
The name of the header is {{{'Min-Expires'}}} and the decoded value is an integer.
510 59 Adrian Georgescu
511 59 Adrian Georgescu
=== MaxExpiresHeader ===
512 59 Adrian Georgescu
513 59 Adrian Georgescu
The name of the header is {{{'Max-Expires'}}} and the decoded value is an integer.
514 59 Adrian Georgescu
515 59 Adrian Georgescu
=== UsePathHeader ===
516 59 Adrian Georgescu
517 59 Adrian Georgescu
The name of the header is {{{'Use-Path'}}} and the decoded value is a deque of {{{URI}}} objects.
518 59 Adrian Georgescu
519 59 Adrian Georgescu
=== WWWAuthenticateHeader ===
520 59 Adrian Georgescu
521 59 Adrian Georgescu
The name of the header is {{{'WWW-Authenticate'}}} and the decoded value is a dictionary of the parameters within the header.
522 59 Adrian Georgescu
523 59 Adrian Georgescu
=== AuthorizationHeader ===
524 59 Adrian Georgescu
525 59 Adrian Georgescu
The name of the header is {{{'Authorization'}}} and the decoded value is a dictionary of the parameters within the header.
526 59 Adrian Georgescu
527 59 Adrian Georgescu
=== AuthenticationInfoHeader ===
528 59 Adrian Georgescu
529 59 Adrian Georgescu
The name of the header is {{{'Authentication-Info'}}} and the decoded value is a dictionary of the parameters within the header.
530 59 Adrian Georgescu
531 59 Adrian Georgescu
=== ContentTypeHeader ===
532 59 Adrian Georgescu
533 59 Adrian Georgescu
The name of the header is {{{'Content-Type'}}} and the decoded value is the string representing the MIME type.
534 59 Adrian Georgescu
535 59 Adrian Georgescu
=== ContentIDHeader ===
536 59 Adrian Georgescu
537 59 Adrian Georgescu
The name of the header is {{{'Content-ID'}}} and the decoded value is the string with the value of the header.
538 59 Adrian Georgescu
539 59 Adrian Georgescu
=== ContentDescriptionHeader ===
540 59 Adrian Georgescu
541 59 Adrian Georgescu
The name of the header is {{{'Content-Description'}}} and the decoded value is the string with the value of the header.
542 59 Adrian Georgescu
543 59 Adrian Georgescu
=== ContentDispositionHeader ===
544 59 Adrian Georgescu
545 59 Adrian Georgescu
The name of the header is {{{'Content-Disposition'}}} and the decoded value is a list with two elements: the disposition and a dict with the parameters.
546 59 Adrian Georgescu
547 49 Adrian Georgescu
548 46 Luci Stanescu
== Logging ==
549 46 Luci Stanescu
550 46 Luci Stanescu
Logging is done throughout the library using objects defined by the application, called loggers. If logging is not desired, the {{{application.python.Null}}} object of {{{python-application}}} can be used. These loggers must define the following methods:
551 46 Luci Stanescu
552 46 Luci Stanescu
==== methods ====
553 46 Luci Stanescu
554 46 Luci Stanescu
 '''received_new_chunk'''('''data''', '''transport''', '''chunk''')::
555 46 Luci Stanescu
  This method is called when the start of a new chunk is received.
556 46 Luci Stanescu
  [[BR]]''data'':[[BR]]
557 46 Luci Stanescu
  The data which came along with the start of the chunk.
558 46 Luci Stanescu
  [[BR]]''transport'':[[BR]]
559 46 Luci Stanescu
  The {{{MSRPTransport}}} instance on which the chunk was received.
560 46 Luci Stanescu
  [[BR]]''chunk'':[[BR]]
561 46 Luci Stanescu
  The actual chunk object.
562 46 Luci Stanescu
563 46 Luci Stanescu
 '''received_chunk_data'''('''data''', '''transport''', '''transaction_id''')::
564 46 Luci Stanescu
  This method is called when data is received as part of a chunk previously announced via '''received_new_chunk'''.
565 46 Luci Stanescu
  [[BR]]''data'':[[BR]]
566 46 Luci Stanescu
  The data received as part of the chunk.
567 47 Luci Stanescu
  [[BR]]''transport'':[[BR]]
568 46 Luci Stanescu
  The {{{MSRPTransport}}} instance on which the chunk was received.
569 46 Luci Stanescu
  [[BR]]''transaction_id'':[[BR]]
570 46 Luci Stanescu
  The transaction ID which identifies the chunk for which data was received.
571 46 Luci Stanescu
572 46 Luci Stanescu
 '''received_chunk_end'''('''data''', '''transport''', '''transaction_id''')::
573 46 Luci Stanescu
  This method is called when the last data of a chunk is received. The chunk was previously announced via '''received_new_chunk'''.
574 46 Luci Stanescu
  [[BR]]''data'':[[BR]]
575 46 Luci Stanescu
  The last data received as part of the chunk.
576 46 Luci Stanescu
  [[BR]]''transport'':[[BR]]
577 46 Luci Stanescu
  The {{{MSRPTransport}}} instance on which the chunk was received.
578 46 Luci Stanescu
  [[BR]]''transaction_id'':[[BR]]
579 46 Luci Stanescu
  The transaction ID which identifies the chunk which was ended.
580 46 Luci Stanescu
581 46 Luci Stanescu
 '''sent_new_chunk'''('''data''', '''transport''', '''chunk''')::
582 46 Luci Stanescu
  This method is called when the start of a new chunk is sent.
583 46 Luci Stanescu
  [[BR]]''data'':[[BR]]
584 46 Luci Stanescu
  The data which was sent along with the start of the chunk.
585 46 Luci Stanescu
  [[BR]]''transport'':[[BR]]
586 46 Luci Stanescu
  The {{{MSRPTransport}}} instance on which the chunk was sent.
587 46 Luci Stanescu
  [[BR]]''chunk'':[[BR]]
588 46 Luci Stanescu
  The actual chunk object.
589 46 Luci Stanescu
590 46 Luci Stanescu
 '''sent_chunk_data'''('''data''', '''transport''', '''transaction_id''')::
591 46 Luci Stanescu
  This method is called when data is sent as part of a chunk previously announced via '''sent_new_chunk'''.
592 46 Luci Stanescu
  [[BR]]''data'':[[BR]]
593 46 Luci Stanescu
  The data sent as part of the chunk.
594 47 Luci Stanescu
  [[BR]]''transport'':[[BR]]
595 46 Luci Stanescu
  The {{{MSRPTransport}}} instance on which the chunk was sent.
596 46 Luci Stanescu
  [[BR]]''transaction_id'':[[BR]]
597 46 Luci Stanescu
  The transaction ID which identifies the chunk for which data was sent.
598 46 Luci Stanescu
599 46 Luci Stanescu
 '''sent_chunk_end'''('''data''', '''transport''', '''transaction_id''')::
600 46 Luci Stanescu
  This method is called when the last data of a chunk is sent. The chunk was previously announced via '''sent_new_chunk'''.
601 46 Luci Stanescu
  [[BR]]''data'':[[BR]]
602 46 Luci Stanescu
  The last data sent as part of the chunk.
603 46 Luci Stanescu
  [[BR]]''transport'':[[BR]]
604 46 Luci Stanescu
  The {{{MSRPTransport}}} instance on which the chunk was sent.
605 46 Luci Stanescu
  [[BR]]''transaction_id'':[[BR]]
606 46 Luci Stanescu
  The transaction ID which identifies the chunk which was ended.
607 46 Luci Stanescu
608 46 Luci Stanescu
 '''debug'''('''message''')::
609 46 Luci Stanescu
  This method is called when a debug level message is sent by the library.
610 46 Luci Stanescu
611 46 Luci Stanescu
 '''info'''('''message''')::
612 46 Luci Stanescu
  This method is called when a info level message is sent by the library.
613 46 Luci Stanescu
614 46 Luci Stanescu
 '''warn'''('''message''')::
615 46 Luci Stanescu
  This method is called when a warning level message is sent by the library.
616 46 Luci Stanescu
617 38 Adrian Georgescu
 '''error'''('''message''')::
618 39 Luci Stanescu
  This method is called when a error level message is sent by the library.
619 38 Adrian Georgescu
620 38 Adrian Georgescu
 '''fatal'''('''message''')::
621 1 Adrian Georgescu
  This method is called when a fatal level message is sent by the library.
622 1 Adrian Georgescu
623 52 Luci Stanescu
== Examples ==
624 1 Adrian Georgescu
625 52 Luci Stanescu
=== Creating an outbound connection ===
626 1 Adrian Georgescu
627 52 Luci Stanescu
When creating an outbound connection, a relay is not usually used because NAT traversal is not a problem for the endpoing creating the connection. If one is nevertheless desired, a {{{ConnectorRelay}}} can be used instead:
628 1 Adrian Georgescu
629 52 Luci Stanescu
{{{
630 52 Luci Stanescu
from msrplib.connect import ConnectorDirect
631 52 Luci Stanescu
from msrplib.session import MSRPSession
632 1 Adrian Georgescu
633 52 Luci Stanescu
connector = ConnectorDirect()
634 52 Luci Stanescu
full_local_path = connector.prepare()
635 52 Luci Stanescu
try:
636 52 Luci Stanescu
    # put full_local_path in SDP 'a:path' attribute of offer
637 52 Luci Stanescu
    # get full_remote_path from remote's 'a:path: attribute of reply
638 52 Luci Stanescu
    msrp_transport = connector.complete(full_remote_path)
639 52 Luci Stanescu
except:
640 52 Luci Stanescu
    connector.cleanup()
641 52 Luci Stanescu
    raise
642 1 Adrian Georgescu
643 52 Luci Stanescu
def handle_incoming(chunk=None, error=None):
644 52 Luci Stanescu
    if error is not None:
645 52 Luci Stanescu
       print 'Error: %s' % error
646 52 Luci Stanescu
       session.shutdown()
647 52 Luci Stanescu
    elif chunk is not None:
648 52 Luci Stanescu
       print 'Got data: %s' % chunk.data
649 1 Adrian Georgescu
650 52 Luci Stanescu
session = MSRPSession(msrp_transport, on_incoming_cb=handle_incoming)
651 52 Luci Stanescu
session.send_chunk(msrp_transport.make_chunk(data='Hello world!'))
652 52 Luci Stanescu
}}}
653 38 Adrian Georgescu
654 52 Luci Stanescu
=== Waiting for an inbound connection ===
655 52 Luci Stanescu
656 52 Luci Stanescu
When creating an inbound connection, a relay must be used for NAT traversal. However, if one is not desired, an {{{AceptorDirect}}} can be used instead:
657 52 Luci Stanescu
658 38 Adrian Georgescu
{{{
659 52 Luci Stanescu
from msrplib.connect import AcceptorRelay, MSRPRelaySettings
660 52 Luci Stanescu
from msrplib.session import MSRPSession
661 52 Luci Stanescu
662 52 Luci Stanescu
relay = MSRPRelaySettings(domain='example.org', username='user', password='pass')
663 52 Luci Stanescu
connector = AcceptorRelay(relay)
664 1 Adrian Georgescu
full_local_path = connector.prepare()
665 1 Adrian Georgescu
try:
666 52 Luci Stanescu
    # get full_remote_path from remote's 'a:path: attribute of offer
667 52 Luci Stanescu
    # put full_local_path in SDP 'a:path' attribute of reply
668 52 Luci Stanescu
    msrp_transport = connector.complete(full_remote_path)
669 52 Luci Stanescu
except:
670 1 Adrian Georgescu
    connector.cleanup()
671 52 Luci Stanescu
    raise
672 1 Adrian Georgescu
673 52 Luci Stanescu
def handle_incoming(chunk=None, error=None):
674 52 Luci Stanescu
    if error is not None:
675 52 Luci Stanescu
       print 'Error: %s' % error
676 52 Luci Stanescu
       session.shutdown()
677 52 Luci Stanescu
    elif chunk is not None:
678 52 Luci Stanescu
       print 'Got data: %s' % chunk.data
679 1 Adrian Georgescu
680 52 Luci Stanescu
session = MSRPSession(msrp_transport, on_incoming_cb=handle_incoming)
681 52 Luci Stanescu
session.send_chunk(msrp_transport.make_chunk(data='Hello world!'))
682 52 Luci Stanescu
}}}