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_TRANSPORTCHANNELIMPL_H_
29#define TALK_P2P_BASE_TRANSPORTCHANNELIMPL_H_
30
31#include <string>
32#include "talk/p2p/base/transportchannel.h"
33
34namespace buzz { class XmlElement; }
35
36namespace cricket {
37
38class Transport;
39class Candidate;
40
41// Base class for real implementations of TransportChannel.  This includes some
42// methods called only by Transport, which do not need to be exposed to the
43// client.
44class TransportChannelImpl : public TransportChannel {
45 public:
46  TransportChannelImpl(const std::string& name, const std::string& content_type)
47    : TransportChannel(name, content_type) {}
48
49  // Returns the transport that created this channel.
50  virtual Transport* GetTransport() = 0;
51
52  // Begins the process of attempting to make a connection to the other client.
53  virtual void Connect() = 0;
54
55  // Resets this channel back to the initial state (i.e., not connecting).
56  virtual void Reset() = 0;
57
58  // Allows an individual channel to request signaling and be notified when it
59  // is ready.  This is useful if the individual named channels have need to
60  // send their own transport-info stanzas.
61  sigslot::signal0<> SignalRequestSignaling;
62  virtual void OnSignalingReady() = 0;
63
64  // Handles sending and receiving of candidates.  The Transport
65  // receives the candidates and may forward them to the relevant
66  // channel.
67  //
68  // Note: Since candidates are delivered asynchronously to the
69  // channel, they cannot return an error if the message is invalid.
70  // It is assumed that the Transport will have checked validity
71  // before forwarding.
72  sigslot::signal2<TransportChannelImpl*,
73                   const Candidate&> SignalCandidateReady;
74  virtual void OnCandidate(const Candidate& candidate) = 0;
75 private:
76  DISALLOW_EVIL_CONSTRUCTORS(TransportChannelImpl);
77};
78
79}  // namespace cricket
80
81#endif  // TALK_P2P_BASE_TRANSPORTCHANNELIMPL_H_
82