Class: Gruf::Server

Inherits:
Object
  • Object
show all
Includes:
Loggable
Defined in:
lib/gruf/server.rb

Overview

Represents a gRPC server. Automatically loads and augments gRPC handlers and services based on configuration values.

Defined Under Namespace

Classes: ServerAlreadyStartedError

Constant Summary collapse

KILL_SIGNALS = 
%w[INT TERM QUIT].freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Loggable

#logger

Constructor Details

#initialize(opts = {}) ⇒ Server

Initialize the server and load and setup the services

Parameters:

  • opts (Hash) (defaults to: {}) 


42
43
44
45
46
47
48
49
50
51
 
# File 'lib/gruf/server.rb', line 42

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
  @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 ⇒ Object (readonly)

Returns the value of attribute options.



35
36
37
 
# File 'lib/gruf/server.rb', line 35

def options
  @options
end

#port ⇒ Object (readonly)

Returns the value of attribute port.



32
33
34
 
# File 'lib/gruf/server.rb', line 32

def port
  @port
end

Instance Method Details

#add_interceptor(klass, opts = {}) ⇒ Object

Add an interceptor to the server

Parameters:

  • klass (Class) —

    The Interceptor to add to the registry

  • opts (Hash) (defaults to: {}) —

    A hash of options for the interceptor

Raises:



122
123
124
125
126
 
# File 'lib/gruf/server.rb', line 122

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

Parameters:

  • klass (Class)

Raises:



109
110
111
112
113
 
# File 'lib/gruf/server.rb', line 109

def add_service(klass)
  raise ServerAlreadyStartedError if @started

  @services << klass unless @services.include?(klass)
end

#clear_interceptors ⇒ Object

Clear the interceptor registry of interceptors

Raises:



177
178
179
180
181
 
# File 'lib/gruf/server.rb', line 177

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

Parameters:

  • after_class (Class) —

    The interceptor that you want to add the new interceptor after

  • interceptor_class (Class) —

    The Interceptor to add to the registry

  • opts (Hash) (defaults to: {}) —

    A hash of options for the interceptor

Raises:



148
149
150
151
152
 
# File 'lib/gruf/server.rb', line 148

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

Parameters:

  • before_class (Class) —

    The interceptor that you want to add the new interceptor before

  • interceptor_class (Class) —

    The Interceptor to add to the registry

  • opts (Hash) (defaults to: {}) —

    A hash of options for the interceptor

Raises:



135
136
137
138
139
 
# File 'lib/gruf/server.rb', line 135

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

Returns:

  • (Array<Class>) 


159
160
161
 
# File 'lib/gruf/server.rb', line 159

def list_interceptors
  @interceptors.list
end

#remove_interceptor(klass) ⇒ Object

Remove an interceptor from the server

Parameters:

  • klass (Class)

Raises:



168
169
170
171
172
 
# File 'lib/gruf/server.rb', line 168

def remove_interceptor(klass)
  raise ServerAlreadyStartedError if @started

  @interceptors.remove(klass)
end

#server ⇒ GRPC::RpcServer

Returns The GRPC server running.

Returns:

  • (GRPC::RpcServer) —

    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
 
# File 'lib/gruf/server.rb', line 56

def server
  @server ||= begin
    # For backward compatibility, we allow these options to be passed directly
    # in the Gruf::Server options, or via Gruf.rpc_server_options.
    server_options = {
      pool_size: options.fetch(:pool_size, Gruf.rpc_server_options[:pool_size]),
      max_waiting_requests: options.fetch(:max_waiting_requests, Gruf.rpc_server_options[:max_waiting_requests]),
      poll_period: options.fetch(:poll_period, Gruf.rpc_server_options[:poll_period]),
      pool_keep_alive: options.fetch(:pool_keep_alive, Gruf.rpc_server_options[:pool_keep_alive]),
      connect_md_proc: options.fetch(:connect_md_proc, Gruf.rpc_server_options[:connect_md_proc]),
      server_args: options.fetch(:server_args, Gruf.rpc_server_options[:server_args])
    }

    server = if @event_listener_proc
               server_options[:event_listener_proc] = @event_listener_proc
               Gruf::InstrumentableGrpcServer.new(**server_options)
             else
               GRPC::RpcServer.new(**server_options)
             end

    @port = server.add_http2_port(@hostname, ssl_credentials)
    @services.each { |s| server.handle(s) }
    server
  end
end

#start! ⇒ Object

Start the gRPC server

:nocov:



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/gruf/server.rb', line 86

def start!
  update_proc_title(:starting)

  server_thread = Thread.new do
    logger.info { "Starting gruf server at #{@hostname}..." }
    server.run_till_terminated_or_interrupted(KILL_SIGNALS)
  end
  @started = true
  update_proc_title(:serving)
  server_thread.join
  @started = false

  update_proc_title(:stopped)
  logger.info { 'Goodbye!' }
end