1 // Copyright (c) 2012 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.
5 #ifndef REMOTING_HOST_CHROMOTING_MESSAGES_H_
6 #define REMOTING_HOST_CHROMOTING_MESSAGES_H_
8 #include "ipc/ipc_platform_file.h"
9 #include "net/base/ip_endpoint.h"
10 #include "remoting/host/chromoting_param_traits.h"
11 #include "remoting/host/screen_resolution.h"
12 #include "remoting/protocol/transport.h"
13 #include "third_party/webrtc/modules/desktop_capture/desktop_geometry.h"
14 #include "third_party/webrtc/modules/desktop_capture/mouse_cursor_shape.h"
16 #endif // REMOTING_HOST_CHROMOTING_MESSAGES_H_
18 // Multiply-included message file, no traditional include guard.
19 #include "ipc/ipc_message_macros.h"
21 #define IPC_MESSAGE_START ChromotingMsgStart
23 //-----------------------------------------------------------------------------
24 // Chromoting messages sent from the daemon.
26 // Requests the receiving process to crash producing a crash dump. The daemon
27 // sends this message when a fatal error has been detected indicating that
28 // the receiving process misbehaves. The daemon passes the location of the code
29 // that detected the error.
30 IPC_MESSAGE_CONTROL3(ChromotingDaemonMsg_Crash
,
31 std::string
/* function_name */,
32 std::string
/* file_name */,
33 int /* line_number */)
35 //-----------------------------------------------------------------------------
36 // Chromoting messages sent from the daemon to the network process.
38 // Delivers the host configuration (and updates) to the network process.
39 IPC_MESSAGE_CONTROL1(ChromotingDaemonNetworkMsg_Configuration
, std::string
)
41 // Initializes the pairing registry on Windows. The passed key handles are
42 // already duplicated by the sender.
43 IPC_MESSAGE_CONTROL2(ChromotingDaemonNetworkMsg_InitializePairingRegistry
,
44 IPC::PlatformFileForTransit
/* privileged_key */,
45 IPC::PlatformFileForTransit
/* unprivileged_key */)
47 // Notifies the network process that the terminal |terminal_id| has been
48 // disconnected from the desktop session.
49 IPC_MESSAGE_CONTROL1(ChromotingDaemonNetworkMsg_TerminalDisconnected
,
50 int /* terminal_id */)
52 // Notifies the network process that |terminal_id| is now attached to
53 // a desktop integration process. |desktop_process| is the handle of the desktop
54 // process. |desktop_pipe| is the client end of the desktop-to-network pipe
57 // Windows only: |desktop_pipe| has to be duplicated from the desktop process
58 // by the receiver of the message. |desktop_process| is already duplicated by
60 IPC_MESSAGE_CONTROL3(ChromotingDaemonNetworkMsg_DesktopAttached
,
61 int /* terminal_id */,
62 base::ProcessHandle
/* desktop_process */,
63 IPC::PlatformFileForTransit
/* desktop_pipe */)
65 //-----------------------------------------------------------------------------
66 // Chromoting messages sent from the network to the daemon process.
68 // Connects the terminal |terminal_id| (i.e. a remote client) to a desktop
70 IPC_MESSAGE_CONTROL3(ChromotingNetworkHostMsg_ConnectTerminal
,
71 int /* terminal_id */,
72 remoting::ScreenResolution
/* resolution */,
73 bool /* virtual_terminal */)
75 // Disconnects the terminal |terminal_id| from the desktop session it was
77 IPC_MESSAGE_CONTROL1(ChromotingNetworkHostMsg_DisconnectTerminal
,
78 int /* terminal_id */)
80 // Changes the screen resolution in the given desktop session.
81 IPC_MESSAGE_CONTROL2(ChromotingNetworkDaemonMsg_SetScreenResolution
,
82 int /* terminal_id */,
83 remoting::ScreenResolution
/* resolution */)
85 // Serialized remoting::protocol::TransportRoute structure.
86 IPC_STRUCT_BEGIN(SerializedTransportRoute
)
87 IPC_STRUCT_MEMBER(int, type
)
88 IPC_STRUCT_MEMBER(net::IPAddressNumber
, remote_address
)
89 IPC_STRUCT_MEMBER(int, remote_port
)
90 IPC_STRUCT_MEMBER(net::IPAddressNumber
, local_address
)
91 IPC_STRUCT_MEMBER(int, local_port
)
94 // Hosts status notifications (see HostStatusObserver interface) sent by
95 // IpcHostEventLogger.
96 IPC_MESSAGE_CONTROL1(ChromotingNetworkDaemonMsg_AccessDenied
,
97 std::string
/* jid */)
99 IPC_MESSAGE_CONTROL1(ChromotingNetworkDaemonMsg_ClientAuthenticated
,
100 std::string
/* jid */)
102 IPC_MESSAGE_CONTROL1(ChromotingNetworkDaemonMsg_ClientConnected
,
103 std::string
/* jid */)
105 IPC_MESSAGE_CONTROL1(ChromotingNetworkDaemonMsg_ClientDisconnected
,
106 std::string
/* jid */)
108 IPC_MESSAGE_CONTROL3(ChromotingNetworkDaemonMsg_ClientRouteChange
,
109 std::string
/* jid */,
110 std::string
/* channel_name */,
111 SerializedTransportRoute
/* route */)
113 IPC_MESSAGE_CONTROL1(ChromotingNetworkDaemonMsg_HostStarted
,
114 std::string
/* xmpp_login */)
116 IPC_MESSAGE_CONTROL0(ChromotingNetworkDaemonMsg_HostShutdown
)
118 //-----------------------------------------------------------------------------
119 // Chromoting messages sent from the desktop to the daemon process.
121 // Notifies the daemon that a desktop integration process has been initialized.
122 // |desktop_pipe| specifies the client end of the desktop pipe. It is to be
123 // forwarded to the desktop environment stub.
125 // Windows only: |desktop_pipe| has to be duplicated from the desktop process by
126 // the receiver of the message.
127 IPC_MESSAGE_CONTROL1(ChromotingDesktopDaemonMsg_DesktopAttached
,
128 IPC::PlatformFileForTransit
/* desktop_pipe */)
130 // Asks the daemon to inject Secure Attention Sequence (SAS) in the session
131 // where the desktop process is running.
132 IPC_MESSAGE_CONTROL0(ChromotingDesktopDaemonMsg_InjectSas
)
134 //-----------------------------------------------------------------------------
135 // Chromoting messages sent from the desktop to the network process.
137 // Notifies the network process that a shared buffer has been created.
138 IPC_MESSAGE_CONTROL3(ChromotingDesktopNetworkMsg_CreateSharedBuffer
,
140 IPC::PlatformFileForTransit
/* handle */,
143 // Request the network process to stop using a shared buffer.
144 IPC_MESSAGE_CONTROL1(ChromotingDesktopNetworkMsg_ReleaseSharedBuffer
,
147 // Serialized webrtc::DesktopFrame.
148 IPC_STRUCT_BEGIN(SerializedDesktopFrame
)
149 // ID of the shared memory buffer containing the pixels.
150 IPC_STRUCT_MEMBER(int, shared_buffer_id
)
152 // Width of a single row of pixels in bytes.
153 IPC_STRUCT_MEMBER(int, bytes_per_row
)
156 IPC_STRUCT_MEMBER(std::vector
<webrtc::DesktopRect
>, dirty_region
)
158 // Dimensions of the buffer in pixels.
159 IPC_STRUCT_MEMBER(webrtc::DesktopSize
, dimensions
)
161 // Time spent in capture. Unit is in milliseconds.
162 IPC_STRUCT_MEMBER(int64
, capture_time_ms
)
164 // Sequence number supplied by client for performance tracking.
165 IPC_STRUCT_MEMBER(int64
, client_sequence_number
)
167 // DPI for this frame.
168 IPC_STRUCT_MEMBER(webrtc::DesktopVector
, dpi
)
171 // Notifies the network process that a shared buffer has been created.
172 IPC_MESSAGE_CONTROL1(ChromotingDesktopNetworkMsg_CaptureCompleted
,
173 SerializedDesktopFrame
/* frame */ )
175 // Carries a cursor share update from the desktop session agent to the client.
176 IPC_MESSAGE_CONTROL1(ChromotingDesktopNetworkMsg_MouseCursor
,
177 webrtc::MouseCursor
/* cursor */ )
179 // Carries a clipboard event from the desktop session agent to the client.
180 // |serialized_event| is a serialized protocol::ClipboardEvent.
181 IPC_MESSAGE_CONTROL1(ChromotingDesktopNetworkMsg_InjectClipboardEvent
,
182 std::string
/* serialized_event */ )
184 // Requests the network process to terminate the client session.
185 IPC_MESSAGE_CONTROL0(ChromotingDesktopNetworkMsg_DisconnectSession
)
187 // Carries an audio packet from the desktop session agent to the client.
188 // |serialized_packet| is a serialized AudioPacket.
189 IPC_MESSAGE_CONTROL1(ChromotingDesktopNetworkMsg_AudioPacket
,
190 std::string
/* serialized_packet */ )
192 //-----------------------------------------------------------------------------
193 // Chromoting messages sent from the network to the desktop process.
195 // Passes the client session data to the desktop session agent and starts it.
196 // This must be the first message received from the host.
197 IPC_MESSAGE_CONTROL3(ChromotingNetworkDesktopMsg_StartSessionAgent
,
198 std::string
/* authenticated_jid */,
199 remoting::ScreenResolution
/* resolution */,
200 bool /* virtual_terminal */)
202 IPC_MESSAGE_CONTROL0(ChromotingNetworkDesktopMsg_CaptureFrame
)
204 // Carries a clipboard event from the client to the desktop session agent.
205 // |serialized_event| is a serialized protocol::ClipboardEvent.
206 IPC_MESSAGE_CONTROL1(ChromotingNetworkDesktopMsg_InjectClipboardEvent
,
207 std::string
/* serialized_event */ )
209 // Carries a keyboard event from the client to the desktop session agent.
210 // |serialized_event| is a serialized protocol::KeyEvent.
211 IPC_MESSAGE_CONTROL1(ChromotingNetworkDesktopMsg_InjectKeyEvent
,
212 std::string
/* serialized_event */ )
214 // Carries a keyboard event from the client to the desktop session agent.
215 // |serialized_event| is a serialized protocol::TextEvent.
216 IPC_MESSAGE_CONTROL1(ChromotingNetworkDesktopMsg_InjectTextEvent
,
217 std::string
/* serialized_event */ )
219 // Carries a mouse event from the client to the desktop session agent.
220 // |serialized_event| is a serialized protocol::MouseEvent.
221 IPC_MESSAGE_CONTROL1(ChromotingNetworkDesktopMsg_InjectMouseEvent
,
222 std::string
/* serialized_event */ )
224 // Changes the screen resolution in the desktop session.
225 IPC_MESSAGE_CONTROL1(ChromotingNetworkDesktopMsg_SetScreenResolution
,
226 remoting::ScreenResolution
/* resolution */)