Class: Gruf::Server
Overview
Represents a gRPC server. Automatically loads and augments gRPC handlers and services based on configuration values.
Defined Under Namespace
Classes: ServerAlreadyStartedError
Instance Attribute Summary collapse
-
#options ⇒ Hash
readonly
Hash of options passed into the server.
-
#port ⇒ Integer
readonly
The port the server is bound to.
Instance Method Summary collapse
-
#add_interceptor(klass, opts = {}) ⇒ Object
Add an interceptor to the server.
-
#add_service(klass) ⇒ Object
Add a gRPC service stub to be served by gruf.
-
#clear_interceptors ⇒ Object
Clear the interceptor registry of interceptors.
-
#initialize(opts = {}) ⇒ Server
constructor
Initialize the server and load and setup the services.
-
#insert_interceptor_after(after_class, interceptor_class, opts = {}) ⇒ Object
Insert an interceptor after another in the currently registered order of execution.
-
#insert_interceptor_before(before_class, interceptor_class, opts = {}) ⇒ Object
Insert an interceptor before another in the currently registered order of execution.
-
#list_interceptors ⇒ Array<Class>
Return the current list of added interceptor classes.
-
#remove_interceptor(klass) ⇒ Object
Remove an interceptor from the server.
-
#server ⇒ GRPC::RpcServer
The GRPC server running.
-
#start! ⇒ Object
Start the gRPC server.
Methods included from Loggable
Constructor Details
#initialize(opts = {}) ⇒ Server
Initialize the server and load and setup the services
38 39 40 41 42 43 44 45 46 47 48 49 50 51 |
# File 'lib/gruf/server.rb', line 38 def initialize(opts = {}) @options = opts || {} @interceptors = opts.fetch(:interceptor_registry, Gruf.interceptors) @interceptors = Gruf::Interceptors::Registry.new unless @interceptors.is_a?(Gruf::Interceptors::Registry) @services = [] @started = false @stop_server = false @stop_server_cv = ConditionVariable.new @stop_server_mu = Monitor.new @server_mu = Monitor.new @hostname = opts.fetch(:hostname, Gruf.server_binding_url) @event_listener_proc = opts.fetch(:event_listener_proc, Gruf.event_listener_proc) setup end |
Instance Attribute Details
#options ⇒ Hash (readonly)
Returns Hash of options passed into the server.
31 32 33 |
# File 'lib/gruf/server.rb', line 31 def @options end |
#port ⇒ Integer (readonly)
Returns The port the server is bound to.
29 30 31 |
# File 'lib/gruf/server.rb', line 29 def port @port end |
Instance Method Details
#add_interceptor(klass, opts = {}) ⇒ Object
Add an interceptor to the server
137 138 139 140 141 |
# File 'lib/gruf/server.rb', line 137 def add_interceptor(klass, opts = {}) raise ServerAlreadyStartedError if @started @interceptors.use(klass, opts) end |
#add_service(klass) ⇒ Object
Add a gRPC service stub to be served by gruf
124 125 126 127 128 |
# File 'lib/gruf/server.rb', line 124 def add_service(klass) raise ServerAlreadyStartedError if @started @services << klass unless @services.include?(klass) end |
#clear_interceptors ⇒ Object
Clear the interceptor registry of interceptors
192 193 194 195 196 |
# File 'lib/gruf/server.rb', line 192 def clear_interceptors raise ServerAlreadyStartedError if @started @interceptors.clear end |
#insert_interceptor_after(after_class, interceptor_class, opts = {}) ⇒ Object
Insert an interceptor after another in the currently registered order of execution
163 164 165 166 167 |
# File 'lib/gruf/server.rb', line 163 def insert_interceptor_after(after_class, interceptor_class, opts = {}) raise ServerAlreadyStartedError if @started @interceptors.insert_after(after_class, interceptor_class, opts) end |
#insert_interceptor_before(before_class, interceptor_class, opts = {}) ⇒ Object
Insert an interceptor before another in the currently registered order of execution
150 151 152 153 154 |
# File 'lib/gruf/server.rb', line 150 def insert_interceptor_before(before_class, interceptor_class, opts = {}) raise ServerAlreadyStartedError if @started @interceptors.insert_before(before_class, interceptor_class, opts) end |
#list_interceptors ⇒ Array<Class>
Return the current list of added interceptor classes
174 175 176 |
# File 'lib/gruf/server.rb', line 174 def list_interceptors @interceptors.list end |
#remove_interceptor(klass) ⇒ Object
Remove an interceptor from the server
183 184 185 186 187 |
# File 'lib/gruf/server.rb', line 183 def remove_interceptor(klass) raise ServerAlreadyStartedError if @started @interceptors.remove(klass) end |
#server ⇒ GRPC::RpcServer
Returns The GRPC server running.
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 |
# File 'lib/gruf/server.rb', line 56 def server @server_mu.synchronize do @server ||= begin # For backward compatibility, we allow these options to be passed directly # in the Gruf::Server options, or via Gruf.rpc_server_options. = { pool_size: .fetch(:pool_size, Gruf.[:pool_size]), max_waiting_requests: .fetch(:max_waiting_requests, Gruf.[:max_waiting_requests]), poll_period: .fetch(:poll_period, Gruf.[:poll_period]), pool_keep_alive: .fetch(:pool_keep_alive, Gruf.[:pool_keep_alive]), connect_md_proc: .fetch(:connect_md_proc, Gruf.[:connect_md_proc]), server_args: .fetch(:server_args, Gruf.[:server_args]) } server = if @event_listener_proc [:event_listener_proc] = @event_listener_proc Gruf::InstrumentableGrpcServer.new() else GRPC::RpcServer.new() end @port = server.add_http2_port(@hostname, ssl_credentials) @services.each { |s| server.handle(s) } server end end end |
#start! ⇒ Object
Start the gRPC server
:nocov:
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 |
# File 'lib/gruf/server.rb', line 88 def start! update_proc_title(:starting) server_thread = Thread.new do logger.info { "Starting gruf server at #{@hostname}..." } server.run end stop_server_thread = Thread.new do loop do break if @stop_server @stop_server_mu.synchronize { @stop_server_cv.wait(@stop_server_mu, 10) } end logger.info { 'Shutting down...' } server.stop end server.wait_till_running @started = true update_proc_title(:serving) stop_server_thread.join server_thread.join @started = false update_proc_title(:stopped) logger.info { 'Goodbye!' } end |