[go: nahoru, domu]
Google Git
Sign in
chromium / chromium / src / cc8f146d34a3b13cd80d8b3530fd76445774b1c6 / . / chrome / common / ipc_channel.h
blob: 85b35fae5cbd76bc56155e21aeaa2d0bd917f89e [file] [log] [blame]
license.botbf09a502008-08-24 00:55:55[diff] [blame]1// Copyright (c) 2006-2008 The Chromium Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
initial.commit09911bf2008-07-26 23:55:29[diff] [blame]4
agl@chromium.org82e5ee82009-04-03 02:29:45[diff] [blame]5#ifndef CHROME_COMMON_IPC_CHANNEL_H_
6#define CHROME_COMMON_IPC_CHANNEL_H_
initial.commit09911bf2008-07-26 23:55:29[diff] [blame]7
agl@chromium.org82e5ee82009-04-03 02:29:45[diff] [blame]8#include "chrome/common/ipc_message.h"
initial.commit09911bf2008-07-26 23:55:29[diff] [blame]9
10namespace IPC {
11
12//------------------------------------------------------------------------------
13
jeremy@chromium.org514411fc2008-12-10 22:28:11[diff] [blame]14class Channel : public Message::Sender {
initial.commit09911bf2008-07-26 23:55:29[diff] [blame]15 // Security tests need access to the pipe handle.
16 friend class ChannelTest;
17
18 public:
19 // Implemented by consumers of a Channel to receive messages.
20 class Listener {
21 public:
darin@google.comc8ea1ef2008-09-06 18:07:10[diff] [blame]22 virtual ~Listener() {}
23
initial.commit09911bf2008-07-26 23:55:29[diff] [blame]24 // Called when a message is received.
25 virtual void OnMessageReceived(const Message& message) = 0;
26
27 // Called when the channel is connected and we have received the internal
28 // Hello message from the peer.
29 virtual void OnChannelConnected(int32 peer_pid) {}
30
31 // Called when an error is detected that causes the channel to close.
32 // This method is not called when a channel is closed normally.
33 virtual void OnChannelError() {}
34 };
35
36 enum Mode {
37 MODE_SERVER,
38 MODE_CLIENT
39 };
40
initial.commit09911bf2008-07-26 23:55:29[diff] [blame]41 enum {
jeremy@chromium.org514411fc2008-12-10 22:28:11[diff] [blame]42 // The maximum message size in bytes. Attempting to receive a
43 // message of this size or bigger results in a channel error.
44 kMaximumMessageSize = 256 * 1024 * 1024,
45
46 // Ammount of data to read at once from the pipe.
47 kReadBufferSize = 4 * 1024
initial.commit09911bf2008-07-26 23:55:29[diff] [blame]48 };
49
50 // Initialize a Channel.
51 //
rvargas@google.comc1afbd2c2008-10-13 19:19:36[diff] [blame]52 // |channel_id| identifies the communication Channel.
53 // |mode| specifies whether this Channel is to operate in server mode or
54 // client mode. In server mode, the Channel is responsible for setting up the
55 // IPC object, whereas in client mode, the Channel merely connects to the
56 // already established IPC object.
57 // |listener| receives a callback on the current thread for each newly
58 // received message.
initial.commit09911bf2008-07-26 23:55:29[diff] [blame]59 //
evan@chromium.org9a3a293b2009-06-04 22:28:16[diff] [blame]60 Channel(const std::string& channel_id, Mode mode, Listener* listener);
initial.commit09911bf2008-07-26 23:55:29[diff] [blame]61
jeremy@chromium.org514411fc2008-12-10 22:28:11[diff] [blame]62 ~Channel();
initial.commit09911bf2008-07-26 23:55:29[diff] [blame]63
64 // Connect the pipe. On the server side, this will initiate
65 // waiting for connections. On the client, it attempts to
66 // connect to a pre-existing pipe. Note, calling Connect()
67 // will not block the calling thread and may complete
68 // asynchronously.
69 bool Connect();
70
71 // Close this Channel explicitly. May be called multiple times.
72 void Close();
73
74 // Modify the Channel's listener.
jeremy@chromium.org514411fc2008-12-10 22:28:11[diff] [blame]75 void set_listener(Listener* listener);
initial.commit09911bf2008-07-26 23:55:29[diff] [blame]76
77 // Send a message over the Channel to the listener on the other end.
78 //
rvargas@google.comc1afbd2c2008-10-13 19:19:36[diff] [blame]79 // |message| must be allocated using operator new. This object will be
80 // deleted once the contents of the Message have been sent.
initial.commit09911bf2008-07-26 23:55:29[diff] [blame]81 //
82 // FIXME bug 551500: the channel does not notice failures, so if the
83 // renderer crashes, it will silently succeed, leaking the parameter.
84 // At least the leak will be fixed by...
85 //
86 virtual bool Send(Message* message);
87
jeremy@chromium.orgdf3c1ca12008-12-19 21:37:01[diff] [blame]88#if defined(OS_POSIX)
89 // On POSIX an IPC::Channel wraps a socketpair(), this method returns the
agl@chromium.orgcc8f1462009-06-12 17:36:55[diff] [blame^]90 // FD # for the client end of the socket.
jeremy@chromium.orgdf3c1ca12008-12-19 21:37:01[diff] [blame]91 // This method may only be called on the server side of a channel.
92 //
93 // If the kTestingChannelID flag is specified on the command line then
94 // a named FIFO is used as the channel transport mechanism rather than a
agl@chromium.orgcc8f1462009-06-12 17:36:55[diff] [blame^]95 // socketpair() in which case this method returns -1.
96 int GetClientFileDescriptor() const;
jeremy@chromium.orgdf3c1ca12008-12-19 21:37:01[diff] [blame]97#endif // defined(OS_POSIX)
98
initial.commit09911bf2008-07-26 23:55:29[diff] [blame]99 private:
jeremy@chromium.org514411fc2008-12-10 22:28:11[diff] [blame]100 // PIMPL to which all channel calls are delegated.
101 class ChannelImpl;
102 ChannelImpl *channel_impl_;
rvargas@google.comc1afbd2c2008-10-13 19:19:36[diff] [blame]103
initial.commit09911bf2008-07-26 23:55:29[diff] [blame]104 // The Hello message is internal to the Channel class. It is sent
105 // by the peer when the channel is connected. The message contains
106 // just the process id (pid). The message has a special routing_id
107 // (MSG_ROUTING_NONE) and type (HELLO_MESSAGE_TYPE).
108 enum {
nsylvain@chromium.orgd4651ff2008-12-02 16:51:58[diff] [blame]109 HELLO_MESSAGE_TYPE = kuint16max // Maximum value of message type (uint16),
110 // to avoid conflicting with normal
111 // message types, which are enumeration
112 // constants starting from 0.
initial.commit09911bf2008-07-26 23:55:29[diff] [blame]113 };
114};
115
jeremy@chromium.org514411fc2008-12-10 22:28:11[diff] [blame]116} // namespace IPC
initial.commit09911bf2008-07-26 23:55:29[diff] [blame]117
agl@chromium.org82e5ee82009-04-03 02:29:45[diff] [blame]118#endif // CHROME_COMMON_IPC_CHANNEL_H_