blob: cd802d138de47bc791f6780827bb2a3f591d696e (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
|
/*
* Copyright (C) 2017 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef INCLUDE_PERFETTO_IPC_CLIENT_H_
#define INCLUDE_PERFETTO_IPC_CLIENT_H_
#include <functional>
#include <memory>
#include "perfetto/base/scoped_file.h"
#include "perfetto/base/weak_ptr.h"
#include "perfetto/ipc/basic_types.h"
namespace perfetto {
namespace base {
class TaskRunner;
} // namespace base
namespace ipc {
class ServiceProxy;
// The client-side class that talks to the host over the socket and multiplexes
// requests coming from the various autogenerated ServiceProxy stubs.
// This is meant to be used by the user code as follows:
// auto client = Client::CreateInstance("socket_name", task_runner);
// std::unique_ptr<GreeterService> svc(new GreeterService());
// client.BindService(svc);
// svc.OnConnect([] () {
// svc.SayHello(..., ...);
// });
class Client {
public:
static std::unique_ptr<Client> CreateInstance(const char* socket_name,
base::TaskRunner*);
virtual ~Client();
virtual void BindService(base::WeakPtr<ServiceProxy>) = 0;
// There is no need to call this method explicitly. Destroying the
// ServiceProxy instance is sufficient and will automatically unbind it. This
// method is exposed only for the ServiceProxy destructor.
virtual void UnbindService(ServiceID) = 0;
// Returns (with move semantics) the last file descriptor received on the IPC
// channel. No buffering is performed: if a service sends two file descriptors
// and the caller doesn't read them immediately, the first one will be
// automatically closed when the second is received (and will hit a DCHECK in
// debug builds).
virtual base::ScopedFile TakeReceivedFD() = 0;
};
} // namespace ipc
} // namespace perfetto
#endif // INCLUDE_PERFETTO_IPC_CLIENT_H_
|