Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(46)

Side by Side Diff: mojo/public/cpp/bindings/interface_impl.h

Issue 718473003: Add mojo::Binding<Interface> for more flexible pipe<->impl binding (Closed) Base URL: git@github.com:domokit/mojo.git@master
Patch Set: Rename Binding::router() -> Binding::internal_router() Created 6 years, 1 month ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
OLDNEW
1 // Copyright 2014 The Chromium Authors. All rights reserved. 1 // Copyright 2014 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be 2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file. 3 // found in the LICENSE file.
4 4
5 #ifndef MOJO_PUBLIC_CPP_BINDINGS_INTERFACE_IMPL_H_ 5 #ifndef MOJO_PUBLIC_CPP_BINDINGS_INTERFACE_IMPL_H_
6 #define MOJO_PUBLIC_CPP_BINDINGS_INTERFACE_IMPL_H_ 6 #define MOJO_PUBLIC_CPP_BINDINGS_INTERFACE_IMPL_H_
7 7
8 #include "mojo/public/cpp/bindings/binding.h"
8 #include "mojo/public/cpp/bindings/interface_request.h" 9 #include "mojo/public/cpp/bindings/interface_request.h"
9 #include "mojo/public/cpp/bindings/lib/interface_impl_internal.h"
10 #include "mojo/public/cpp/environment/environment.h" 10 #include "mojo/public/cpp/environment/environment.h"
11 #include "mojo/public/cpp/system/macros.h" 11 #include "mojo/public/cpp/system/macros.h"
12 12
13 namespace mojo { 13 namespace mojo {
14 14
15 // InterfaceImpl<..> is designed to be the base class of an interface 15 // InterfaceImpl<..> is designed to be the base class of an interface
16 // implementation. It may be bound to a pipe or a proxy, see BindToPipe and 16 // implementation. It may be bound to a pipe or a proxy, see BindToPipe and
17 // BindToProxy. 17 // BindToProxy.
DaveMoore 2014/11/13 00:00:36 Nit: add comment that this class is going away.
18 template <typename Interface> 18 template <typename Interface>
19 class InterfaceImpl : public internal::InterfaceImplBase<Interface> { 19 class InterfaceImpl : public Interface, public ErrorHandler {
20 public: 20 public:
21 typedef typename Interface::Client Client; 21 using ImplementedInterface = Interface;
22 typedef Interface ImplementedInterface; 22 using Client = typename Interface::Client;
23 23
24 InterfaceImpl() : internal_state_(this) {} 24 InterfaceImpl() : binding_(this), error_handler_impl_(this) {
25 binding_.set_error_handler(&error_handler_impl_);
26 }
25 virtual ~InterfaceImpl() {} 27 virtual ~InterfaceImpl() {}
26 28
27 // Returns a proxy to the client interface. This is null upon construction, 29 void BindToHandle(
28 // and becomes non-null after OnClientConnected. NOTE: It remains non-null 30 ScopedMessagePipeHandle handle,
29 // until this instance is deleted. 31 const MojoAsyncWaiter* waiter = Environment::GetDefaultAsyncWaiter()) {
30 Client* client() { return internal_state_.client(); } 32 binding_.Bind(handle.Pass(), waiter);
31
32 // Blocks the current thread for the first incoming method call, i.e., either
33 // a call to a method or a client callback method. Returns |true| if a method
34 // has been called, |false| in case of error. It must only be called on a
35 // bound object.
36 bool WaitForIncomingMethodCall() {
37 return internal_state_.WaitForIncomingMethodCall();
38 } 33 }
39 34
40 // Called when the client has connected to this instance. 35 bool WaitForIncomingMethodCall() {
41 virtual void OnConnectionEstablished() {} 36 return binding_.WaitForIncomingMethodCall();
37 }
38
39 Client* client() { return binding_.client(); }
40 internal::Router* internal_router() { return binding_.internal_router(); }
42 41
43 // Called when the client is no longer connected to this instance. NOTE: The 42 // Called when the client is no longer connected to this instance. NOTE: The
44 // client() method continues to return a non-null pointer after this method 43 // client() method continues to return a non-null pointer after this method
45 // is called. After this method is called, any method calls made on client() 44 // is called. After this method is called, any method calls made on client()
46 // will be silently ignored. 45 // will be silently ignored.
47 virtual void OnConnectionError() {} 46 virtual void OnConnectionError() {}
48 47
49 // DO NOT USE. Exposed only for internal use and for testing. 48 void set_delete_on_error(bool delete_on_error) {
50 internal::InterfaceImplState<Interface>* internal_state() { 49 error_handler_impl_.set_delete_on_error(delete_on_error);
51 return &internal_state_;
52 } 50 }
53 51
54 private: 52 private:
55 internal::InterfaceImplState<Interface> internal_state_; 53 class ErrorHandlerImpl : public ErrorHandler {
54 public:
55 explicit ErrorHandlerImpl(InterfaceImpl* impl) : impl_(impl) {}
56 ~ErrorHandlerImpl() override {}
57
58 // ErrorHandler implementation:
59 void OnConnectionError() override {
60 impl_->OnConnectionError();
61 if (delete_on_error_)
62 delete impl_;
63 }
64
65 void set_delete_on_error(bool delete_on_error) {
66 delete_on_error_ = delete_on_error;
67 }
68
69 private:
70 InterfaceImpl* impl_;
71 bool delete_on_error_ = false;
72
73 MOJO_DISALLOW_COPY_AND_ASSIGN(ErrorHandlerImpl);
74 };
75
76 Binding<Interface> binding_;
77 ErrorHandlerImpl error_handler_impl_;
78
56 MOJO_DISALLOW_COPY_AND_ASSIGN(InterfaceImpl); 79 MOJO_DISALLOW_COPY_AND_ASSIGN(InterfaceImpl);
57 }; 80 };
58 81
59 // Takes an instance of an InterfaceImpl<..> subclass and binds it to the given 82 // Takes an instance of an InterfaceImpl<..> subclass and binds it to the given
60 // MessagePipe. The instance is returned for convenience in member initializer 83 // MessagePipe. The instance is returned for convenience in member initializer
61 // lists, etc. 84 // lists, etc.
62 // 85 //
63 // If the pipe is closed, the instance's OnConnectionError method will be called 86 // If the pipe is closed, the instance's OnConnectionError method will be called
64 // and then the instance will be deleted. 87 // and then the instance will be deleted.
65 // 88 //
66 // The instance is also bound to the current thread. Its methods will only be 89 // The instance is also bound to the current thread. Its methods will only be
67 // called on the current thread, and if the current thread exits, then the end 90 // called on the current thread, and if the current thread exits, then the end
68 // point of the pipe will be closed and the error handler's OnConnectionError 91 // point of the pipe will be closed and the error handler's OnConnectionError
69 // method will be called. 92 // method will be called.
70 //
71 // Before returning, the instance's OnConnectionEstablished method is called.
72 template <typename Impl> 93 template <typename Impl>
73 Impl* BindToPipe( 94 Impl* BindToPipe(
74 Impl* instance, 95 Impl* instance,
75 ScopedMessagePipeHandle handle, 96 ScopedMessagePipeHandle handle,
76 const MojoAsyncWaiter* waiter = Environment::GetDefaultAsyncWaiter()) { 97 const MojoAsyncWaiter* waiter = Environment::GetDefaultAsyncWaiter()) {
77 instance->internal_state()->Bind(handle.Pass(), true, waiter); 98 instance->set_delete_on_error(true);
99 instance->BindToHandle(handle.Pass(), waiter);
78 return instance; 100 return instance;
79 } 101 }
80 102
81 // Like BindToPipe but does not delete the instance after a channel error. 103 // Like BindToPipe but does not delete the instance after a channel error.
82 template <typename Impl> 104 template <typename Impl>
83 Impl* WeakBindToPipe( 105 Impl* WeakBindToPipe(
84 Impl* instance, 106 Impl* instance,
85 ScopedMessagePipeHandle handle, 107 ScopedMessagePipeHandle handle,
86 const MojoAsyncWaiter* waiter = Environment::GetDefaultAsyncWaiter()) { 108 const MojoAsyncWaiter* waiter = Environment::GetDefaultAsyncWaiter()) {
87 instance->internal_state()->Bind(handle.Pass(), false, waiter); 109 instance->BindToHandle(handle.Pass(), waiter);
88 return instance; 110 return instance;
89 } 111 }
90 112
91 // Takes an instance of an InterfaceImpl<..> subclass and binds it to the given 113 // Takes an instance of an InterfaceImpl<..> subclass and binds it to the given
92 // InterfacePtr<..>. The instance is returned for convenience in member 114 // InterfacePtr<..>. The instance is returned for convenience in member
93 // initializer lists, etc. If the pipe is closed, the instance's 115 // initializer lists, etc. If the pipe is closed, the instance's
94 // OnConnectionError method will be called and then the instance will be 116 // OnConnectionError method will be called and then the instance will be
95 // deleted. 117 // deleted.
96 // 118 //
97 // The instance is also bound to the current thread. Its methods will only be 119 // The instance is also bound to the current thread. Its methods will only be
98 // called on the current thread, and if the current thread exits, then it will 120 // called on the current thread, and if the current thread exits, then it will
99 // also be deleted, and along with it, its end point of the pipe will be closed. 121 // also be deleted, and along with it, its end point of the pipe will be closed.
100 //
101 // Before returning, the instance's OnConnectionEstablished method is called.
102 template <typename Impl, typename Interface> 122 template <typename Impl, typename Interface>
103 Impl* BindToProxy( 123 Impl* BindToProxy(
104 Impl* instance, 124 Impl* instance,
105 InterfacePtr<Interface>* ptr, 125 InterfacePtr<Interface>* ptr,
106 const MojoAsyncWaiter* waiter = Environment::GetDefaultAsyncWaiter()) { 126 const MojoAsyncWaiter* waiter = Environment::GetDefaultAsyncWaiter()) {
107 instance->internal_state()->BindProxy(ptr, true, waiter); 127 instance->set_delete_on_error(true);
128 WeakBindToProxy(instance, ptr, waiter);
108 return instance; 129 return instance;
109 } 130 }
110 131
111 // Like BindToProxy but does not delete the instance after a channel error. 132 // Like BindToProxy but does not delete the instance after a channel error.
112 template <typename Impl, typename Interface> 133 template <typename Impl, typename Interface>
113 Impl* WeakBindToProxy( 134 Impl* WeakBindToProxy(
114 Impl* instance, 135 Impl* instance,
115 InterfacePtr<Interface>* ptr, 136 InterfacePtr<Interface>* ptr,
116 const MojoAsyncWaiter* waiter = Environment::GetDefaultAsyncWaiter()) { 137 const MojoAsyncWaiter* waiter = Environment::GetDefaultAsyncWaiter()) {
117 instance->internal_state()->BindProxy(ptr, false, waiter); 138 MessagePipe pipe;
139 ptr->Bind(pipe.handle0.Pass(), waiter);
140 instance->BindToHandle(pipe.handle1.Pass(), waiter);
118 return instance; 141 return instance;
119 } 142 }
120 143
121 // Takes an instance of an InterfaceImpl<..> subclass and binds it to the given 144 // Takes an instance of an InterfaceImpl<..> subclass and binds it to the given
122 // InterfaceRequest<..>. The instance is returned for convenience in member 145 // InterfaceRequest<..>. The instance is returned for convenience in member
123 // initializer lists, etc. If the pipe is closed, the instance's 146 // initializer lists, etc. If the pipe is closed, the instance's
124 // OnConnectionError method will be called and then the instance will be 147 // OnConnectionError method will be called and then the instance will be
125 // deleted. 148 // deleted.
126 // 149 //
127 // The instance is also bound to the current thread. Its methods will only be 150 // The instance is also bound to the current thread. Its methods will only be
(...skipping 15 matching lines...) Expand all
143 Impl* WeakBindToRequest( 166 Impl* WeakBindToRequest(
144 Impl* instance, 167 Impl* instance,
145 InterfaceRequest<Interface>* request, 168 InterfaceRequest<Interface>* request,
146 const MojoAsyncWaiter* waiter = Environment::GetDefaultAsyncWaiter()) { 169 const MojoAsyncWaiter* waiter = Environment::GetDefaultAsyncWaiter()) {
147 return WeakBindToPipe(instance, request->PassMessagePipe(), waiter); 170 return WeakBindToPipe(instance, request->PassMessagePipe(), waiter);
148 } 171 }
149 172
150 } // namespace mojo 173 } // namespace mojo
151 174
152 #endif // MOJO_PUBLIC_CPP_BINDINGS_INTERFACE_IMPL_H_ 175 #endif // MOJO_PUBLIC_CPP_BINDINGS_INTERFACE_IMPL_H_
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698