← Back to branch summary

~ubuntu-branches/debian/experimental/kopete/experimental

« back to all changes in this revision

Viewing changes to protocols/jabber/libjingle/talk/base/maccocoasocketserver.h

  • Committer: Package Import Robot
  • Author(s): Maximiliano Curia
  • Date: 2015-02-24 11:32:57 UTC
  • mfrom: (1.1.41 vivid)
  • Revision ID: package-import@ubuntu.com-20150224113257-gnupg4v7lzz18ij0
Tags: 4:14.12.2-1
* New upstream release (14.12.2).
* Bump Standards-Version to 3.9.6, no changes needed.

Show diffs side-by-side

added added

removed removed

Lines of Context:
protocols/jabber/libjingle/talk/base/maccocoasocketserver.h
 
1
/*
 
2
 * libjingle
 
3
 * Copyright 2007, 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
// A libjingle compatible SocketServer for OSX/iOS/Cocoa.
 
29
 
 
30
#if !defined(USE_COCOA_THREADING) || (!defined(OSX) && !defined(IOS))
 
31
#error You can only include this file on OSX or IOS, and must also define
 
32
#error USE_COCOA_THREADING.
 
33
#endif
 
34
 
 
35
#import <Foundation/Foundation.h>
 
36
 
 
37
#import "talk/base/messagequeue.h"
 
38
#import "talk/base/socketserver.h"
 
39
 
 
40
namespace talk_base {
 
41
class MacCocoaSocketServer;
 
42
}
 
43
 
 
44
// MacCocoaSocketServerHelper serves as a delegate to NSMachPort or a target for
 
45
// a timeout.
 
46
@interface MacCocoaSocketServerHelper : NSObject {
 
47
  // This is a weak reference. This works fine since the
 
48
  // talk_base::MacCocoaSocketServer owns this object.
 
49
  talk_base::MacCocoaSocketServer* socketServer; // weak.
 
50
}
 
51
 
 
52
@end
 
53
 
 
54
namespace talk_base {
 
55
 
 
56
// The name "SocketServer" is misleading for this class. This class inherits
 
57
// from SocketServer, some variants of which create/use physical
 
58
// sockets (specifically, PhysicalSocketServer). A general explanation
 
59
// (courtesy of bpm) is that SocketServer is responsible for allowing a thread
 
60
// to go into an efficient wait state while it waits for a timer to expire or an
 
61
// incoming message from MessageQueue.  For GUI applications, the main thread
 
62
// must continue to pump the main event loop during this wait state, hence the
 
63
// need for specialized SocketServers to run on the main thread.
 
64
//
 
65
// This particular socketServer however cannot handle a generalized wait state.
 
66
// It can only handle Wait when called with cms == 0, or when cms > 0 and
 
67
// process_io is false. In the former case, the process_io argument is ignored,
 
68
// and in the latter case, the thread will sleep for cms milliSeconds.
 
69
//
 
70
// Use this class in a Cocoa application that uses libjingle's Task and
 
71
// MessageQueue, on the main thread. The typical usage is something like this:
 
72
//
 
73
//  talk_base::Thread* current = talk_base::Thread::Current();
 
74
//  MacCocoaSocketServer* ss =
 
75
//      new talk_base::MacCocoaSocketServer(current);
 
76
//  current->set_socketserver(ss);
 
77
//
 
78
//  // Now schedule some libjingle tasks, then call
 
79
//
 
80
//  [NSApp run];
 
81
 
 
82
class MacCocoaSocketServer : public SocketServer {
 
83
 public:
 
84
  explicit MacCocoaSocketServer(MessageQueue* message_queue);
 
85
  virtual ~MacCocoaSocketServer();
 
86
 
 
87
  // SocketServer Interface. We don't create any synchronous sockets.
 
88
  virtual Socket* CreateSocket(int type) { return NULL; }
 
89
  virtual Socket* CreateSocket(int family, int type) { return NULL; }
 
90
 
 
91
  virtual AsyncSocket* CreateAsyncSocket(int type);
 
92
  virtual AsyncSocket* CreateAsyncSocket(int family, int type);
 
93
 
 
94
  virtual bool Wait(int cms, bool process_io);
 
95
  virtual void WakeUp();
 
96
 
 
97
  void Pump();
 
98
 
 
99
 private:
 
100
  // message_queue_ is not owned by this object.
 
101
  // It is cached from the constructor argument.
 
102
  MessageQueue* message_queue_; // weak.
 
103
  MacCocoaSocketServerHelper* helper_;
 
104
  NSTimer* timer_;
 
105
 
 
106
  DISALLOW_EVIL_CONSTRUCTORS(MacCocoaSocketServer);
 
107
};
 
108
 
 
109
}  // namespace talk_base