| OLD | NEW |
| 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. |
| 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 void BindToInterfacePtr( |
| 41 virtual void OnConnectionEstablished() {} | 36 InterfacePtr<Interface>* ptr, |
| 37 const MojoAsyncWaiter* waiter = Environment::GetDefaultAsyncWaiter()) { |
| 38 binding_.Bind(ptr, waiter); |
| 39 } |
| 40 |
| 41 bool WaitForIncomingMethodCall() { |
| 42 return binding_.WaitForIncomingMethodCall(); |
| 43 } |
| 44 |
| 45 Client* client() { return binding_.client(); } |
| 46 internal::Router* router() { return binding_.router(); } |
| 42 | 47 |
| 43 // Called when the client is no longer connected to this instance. NOTE: The | 48 // 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 | 49 // 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() | 50 // is called. After this method is called, any method calls made on client() |
| 46 // will be silently ignored. | 51 // will be silently ignored. |
| 47 virtual void OnConnectionError() {} | 52 virtual void OnConnectionError() {} |
| 48 | 53 |
| 49 // DO NOT USE. Exposed only for internal use and for testing. | 54 void set_delete_on_error(bool delete_on_error) { |
| 50 internal::InterfaceImplState<Interface>* internal_state() { | 55 error_handler_impl_.set_delete_on_error(delete_on_error); |
| 51 return &internal_state_; | |
| 52 } | 56 } |
| 53 | 57 |
| 54 private: | 58 private: |
| 55 internal::InterfaceImplState<Interface> internal_state_; | 59 class ErrorHandlerImpl : public ErrorHandler { |
| 60 public: |
| 61 explicit ErrorHandlerImpl(InterfaceImpl* impl) : impl_(impl) {} |
| 62 ~ErrorHandlerImpl() override {} |
| 63 |
| 64 // ErrorHandler implementation: |
| 65 void OnConnectionError() override { |
| 66 impl_->OnConnectionError(); |
| 67 if (delete_on_error_) |
| 68 delete impl_; |
| 69 } |
| 70 |
| 71 void set_delete_on_error(bool delete_on_error) { |
| 72 delete_on_error_ = delete_on_error; |
| 73 } |
| 74 |
| 75 private: |
| 76 InterfaceImpl* impl_; |
| 77 bool delete_on_error_ = false; |
| 78 |
| 79 MOJO_DISALLOW_COPY_AND_ASSIGN(ErrorHandlerImpl); |
| 80 }; |
| 81 |
| 82 Binding<Interface> binding_; |
| 83 ErrorHandlerImpl error_handler_impl_; |
| 84 |
| 56 MOJO_DISALLOW_COPY_AND_ASSIGN(InterfaceImpl); | 85 MOJO_DISALLOW_COPY_AND_ASSIGN(InterfaceImpl); |
| 57 }; | 86 }; |
| 58 | 87 |
| 59 // Takes an instance of an InterfaceImpl<..> subclass and binds it to the given | 88 // Takes an instance of an InterfaceImpl<..> subclass and binds it to the given |
| 60 // MessagePipe. The instance is returned for convenience in member initializer | 89 // MessagePipe. The instance is returned for convenience in member initializer |
| 61 // lists, etc. | 90 // lists, etc. |
| 62 // | 91 // |
| 63 // If the pipe is closed, the instance's OnConnectionError method will be called | 92 // If the pipe is closed, the instance's OnConnectionError method will be called |
| 64 // and then the instance will be deleted. | 93 // and then the instance will be deleted. |
| 65 // | 94 // |
| 66 // The instance is also bound to the current thread. Its methods will only be | 95 // 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 | 96 // 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 | 97 // point of the pipe will be closed and the error handler's OnConnectionError |
| 69 // method will be called. | 98 // method will be called. |
| 70 // | |
| 71 // Before returning, the instance's OnConnectionEstablished method is called. | |
| 72 template <typename Impl> | 99 template <typename Impl> |
| 73 Impl* BindToPipe( | 100 Impl* BindToPipe( |
| 74 Impl* instance, | 101 Impl* instance, |
| 75 ScopedMessagePipeHandle handle, | 102 ScopedMessagePipeHandle handle, |
| 76 const MojoAsyncWaiter* waiter = Environment::GetDefaultAsyncWaiter()) { | 103 const MojoAsyncWaiter* waiter = Environment::GetDefaultAsyncWaiter()) { |
| 77 instance->internal_state()->Bind(handle.Pass(), true, waiter); | 104 instance->set_delete_on_error(true); |
| 105 instance->BindToHandle(handle.Pass(), waiter); |
| 78 return instance; | 106 return instance; |
| 79 } | 107 } |
| 80 | 108 |
| 81 // Like BindToPipe but does not delete the instance after a channel error. | 109 // Like BindToPipe but does not delete the instance after a channel error. |
| 82 template <typename Impl> | 110 template <typename Impl> |
| 83 Impl* WeakBindToPipe( | 111 Impl* WeakBindToPipe( |
| 84 Impl* instance, | 112 Impl* instance, |
| 85 ScopedMessagePipeHandle handle, | 113 ScopedMessagePipeHandle handle, |
| 86 const MojoAsyncWaiter* waiter = Environment::GetDefaultAsyncWaiter()) { | 114 const MojoAsyncWaiter* waiter = Environment::GetDefaultAsyncWaiter()) { |
| 87 instance->internal_state()->Bind(handle.Pass(), false, waiter); | 115 instance->BindToHandle(handle.Pass(), waiter); |
| 88 return instance; | 116 return instance; |
| 89 } | 117 } |
| 90 | 118 |
| 91 // Takes an instance of an InterfaceImpl<..> subclass and binds it to the given | 119 // Takes an instance of an InterfaceImpl<..> subclass and binds it to the given |
| 92 // InterfacePtr<..>. The instance is returned for convenience in member | 120 // InterfacePtr<..>. The instance is returned for convenience in member |
| 93 // initializer lists, etc. If the pipe is closed, the instance's | 121 // initializer lists, etc. If the pipe is closed, the instance's |
| 94 // OnConnectionError method will be called and then the instance will be | 122 // OnConnectionError method will be called and then the instance will be |
| 95 // deleted. | 123 // deleted. |
| 96 // | 124 // |
| 97 // The instance is also bound to the current thread. Its methods will only be | 125 // 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 | 126 // 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. | 127 // 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> | 128 template <typename Impl, typename Interface> |
| 103 Impl* BindToProxy( | 129 Impl* BindToProxy( |
| 104 Impl* instance, | 130 Impl* instance, |
| 105 InterfacePtr<Interface>* ptr, | 131 InterfacePtr<Interface>* ptr, |
| 106 const MojoAsyncWaiter* waiter = Environment::GetDefaultAsyncWaiter()) { | 132 const MojoAsyncWaiter* waiter = Environment::GetDefaultAsyncWaiter()) { |
| 107 instance->internal_state()->BindProxy(ptr, true, waiter); | 133 instance->set_delete_on_error(true); |
| 134 instance->BindToInterfacePtr(ptr, waiter); |
| 108 return instance; | 135 return instance; |
| 109 } | 136 } |
| 110 | 137 |
| 111 // Like BindToProxy but does not delete the instance after a channel error. | 138 // Like BindToProxy but does not delete the instance after a channel error. |
| 112 template <typename Impl, typename Interface> | 139 template <typename Impl, typename Interface> |
| 113 Impl* WeakBindToProxy( | 140 Impl* WeakBindToProxy( |
| 114 Impl* instance, | 141 Impl* instance, |
| 115 InterfacePtr<Interface>* ptr, | 142 InterfacePtr<Interface>* ptr, |
| 116 const MojoAsyncWaiter* waiter = Environment::GetDefaultAsyncWaiter()) { | 143 const MojoAsyncWaiter* waiter = Environment::GetDefaultAsyncWaiter()) { |
| 117 instance->internal_state()->BindProxy(ptr, false, waiter); | 144 instance->BindToInterfacePtr(ptr, waiter); |
| 118 return instance; | 145 return instance; |
| 119 } | 146 } |
| 120 | 147 |
| 121 // Takes an instance of an InterfaceImpl<..> subclass and binds it to the given | 148 // Takes an instance of an InterfaceImpl<..> subclass and binds it to the given |
| 122 // InterfaceRequest<..>. The instance is returned for convenience in member | 149 // InterfaceRequest<..>. The instance is returned for convenience in member |
| 123 // initializer lists, etc. If the pipe is closed, the instance's | 150 // initializer lists, etc. If the pipe is closed, the instance's |
| 124 // OnConnectionError method will be called and then the instance will be | 151 // OnConnectionError method will be called and then the instance will be |
| 125 // deleted. | 152 // deleted. |
| 126 // | 153 // |
| 127 // The instance is also bound to the current thread. Its methods will only be | 154 // The instance is also bound to the current thread. Its methods will only be |
| (...skipping 15 matching lines...) Expand all Loading... |
| 143 Impl* WeakBindToRequest( | 170 Impl* WeakBindToRequest( |
| 144 Impl* instance, | 171 Impl* instance, |
| 145 InterfaceRequest<Interface>* request, | 172 InterfaceRequest<Interface>* request, |
| 146 const MojoAsyncWaiter* waiter = Environment::GetDefaultAsyncWaiter()) { | 173 const MojoAsyncWaiter* waiter = Environment::GetDefaultAsyncWaiter()) { |
| 147 return WeakBindToPipe(instance, request->PassMessagePipe(), waiter); | 174 return WeakBindToPipe(instance, request->PassMessagePipe(), waiter); |
| 148 } | 175 } |
| 149 | 176 |
| 150 } // namespace mojo | 177 } // namespace mojo |
| 151 | 178 |
| 152 #endif // MOJO_PUBLIC_CPP_BINDINGS_INTERFACE_IMPL_H_ | 179 #endif // MOJO_PUBLIC_CPP_BINDINGS_INTERFACE_IMPL_H_ |
| OLD | NEW |