• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * libjingle
3  * Copyright 2004--2005, Google Inc.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  *  1. Redistributions of source code must retain the above copyright notice,
9  *     this list of conditions and the following disclaimer.
10  *  2. Redistributions in binary form must reproduce the above copyright notice,
11  *     this list of conditions and the following disclaimer in the documentation
12  *     and/or other materials provided with the distribution.
13  *  3. The name of the author may not be used to endorse or promote products
14  *     derived from this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
17  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
18  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
19  * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
22  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
23  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
24  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
25  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27 
28 #ifndef TALK_P2P_BASE_SESSIONCLIENT_H_
29 #define TALK_P2P_BASE_SESSIONCLIENT_H_
30 
31 namespace buzz {
32 class XmlElement;
33 }
34 
35 namespace cricket {
36 
37 struct ParseError;
38 class Session;
39 class SessionDescription;
40 
41 class ContentParser {
42  public:
43   virtual bool ParseContent(SignalingProtocol protocol,
44                             const buzz::XmlElement* elem,
45                             const ContentDescription** content,
46                             ParseError* error) = 0;
47   virtual bool WriteContent(SignalingProtocol protocol,
48                             const ContentDescription* content,
49                             buzz::XmlElement** elem,
50                             WriteError* error) = 0;
~ContentParser()51   virtual ~ContentParser() {}
52 };
53 
54 // A SessionClient exists in 1-1 relation with each session.  The implementor
55 // of this interface is the one that understands *what* the two sides are
56 // trying to send to one another.  The lower-level layers only know how to send
57 // data; they do not know what is being sent.
58 class SessionClient : public ContentParser {
59  public:
60   // Notifies the client of the creation / destruction of sessions of this type.
61   //
62   // IMPORTANT: The SessionClient, in its handling of OnSessionCreate, must
63   // create whatever channels are indicate in the description.  This is because
64   // the remote client may already be attempting to connect those channels. If
65   // we do not create our channel right away, then connection may fail or be
66   // delayed.
67   virtual void OnSessionCreate(Session* session, bool received_initiate) = 0;
68   virtual void OnSessionDestroy(Session* session) = 0;
69 
70   virtual bool ParseContent(SignalingProtocol protocol,
71                             const buzz::XmlElement* elem,
72                             const ContentDescription** content,
73                             ParseError* error) = 0;
74   virtual bool WriteContent(SignalingProtocol protocol,
75                             const ContentDescription* content,
76                             buzz::XmlElement** elem,
77                             WriteError* error) = 0;
78  protected:
79   // The SessionClient interface explicitly does not include destructor
~SessionClient()80   virtual ~SessionClient() { }
81 };
82 
83 }  // namespace cricket
84 
85 #endif  // TALK_P2P_BASE_SESSIONCLIENT_H_
86