pep/xmpp-rs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

jingle_message: Document this module.

Browse source
This commit is contained in:
Emmanuel Gil Peyrot 2018-08-08 20:26:14 +02:00
parent 16b9291475
commit c41fc1ff69
1 changed files with 14 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
src/jingle_message.rs
View file

@ -4,8 +4,6 @@
// License, v. 2.0. If a copy of the MPL was not distributed with this // License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/. // file, You can obtain one at http://mozilla.org/MPL/2.0/.
#![allow(missing_docs)]
use try_from::TryFrom; use try_from::TryFrom;
use minidom::Element; use minidom::Element;
@ -16,16 +14,30 @@ use jingle::SessionId;
use ns; use ns;
/// Defines a protocol for broadcasting Jingle requests to all of the clients
/// of a user.
#[derive(Debug, Clone)] #[derive(Debug, Clone)]
pub enum JingleMI { pub enum JingleMI {
/// Indicates we want to start a Jingle session.
Propose { Propose {
/// The generated session identifier, must be unique between two users.
sid: SessionId, sid: SessionId,
/// The application description of the proposed session.
// TODO: Use a more specialised type here. // TODO: Use a more specialised type here.
description: Element, description: Element,
}, },
/// Cancels a previously proposed session.
Retract(SessionId), Retract(SessionId),
/// Accepts a session proposed by the other party.
Accept(SessionId), Accept(SessionId),
/// Proceed with a previously proposed session.
Proceed(SessionId), Proceed(SessionId),
/// Rejects a session proposed by the other party.
Reject(SessionId), Reject(SessionId),
} }