Support for the Ruby 2.4 series has ended. See here for reference.
Class representing a drb server instance.
A DRbServer must be running in the local process before any incoming dRuby calls can be accepted, or any local objects can be passed as dRuby references to remote processes, even if those local objects are never actually called remotely. You do not need to start a DRbServer in the local process if you are only making outgoing dRuby calls passing marshalled parameters.
Unless multiple servers are being used, the local DRbServer is normally started by calling DRb.start_service
.
List of insecure methods.
These methods are not callable via dRuby.
The front object of the DRbServer.
This object receives remote method calls made on the server's URI alone, with an object id.
The safe level for this server. This is a number corresponding to $SAFE.
The default safe_level
is 0
Set the default access control list to acl
. The default ACL
is nil
.
See also DRb::ACL and new()
# File drb/drb.rb, line 1305 def self.default_acl(acl) @@acl = acl end
Set the default value for the :argc_limit option.
See new(). The initial default value is 256.
# File drb/drb.rb, line 1291 def self.default_argc_limit(argc) @@argc_limit = argc end
Set the default value for the :id_conv option.
See new(). The initial default value is a DRbIdConv
instance.
# File drb/drb.rb, line 1312 def self.default_id_conv(idconv) @@idconv = idconv end
Set the default value for the :load_limit option.
See new(). The initial default value is 25 MB.
# File drb/drb.rb, line 1298 def self.default_load_limit(sz) @@load_limit = sz end
Set the default safe level to level
. The default safe level is 0
See new for more information.
# File drb/drb.rb, line 1319 def self.default_safe_level(level) @@safe_level = level end
Create a new DRbServer instance.
uri
is the URI to bind to. This is normally of the form 'druby://<hostname>:<port>' where <hostname> is a hostname of the local machine. If nil, then the system's default hostname will be bound to, on a port selected by the system; these value can be retrieved from the uri
attribute. 'druby:' specifies the default dRuby transport protocol: another protocol, such as 'drbunix:', can be specified instead.
front
is the front object for the server, that is, the object to which remote method calls on the server will be passed. If nil, then the server will not accept remote method calls.
If config_or_acl
is a hash, it is the configuration to use for this server. The following options are recognised:
an id-to-object conversion object. This defaults to an instance of the class DRb::DRbIdConv
.
if true, all unsuccessful remote calls on objects in the server will be logged to $stdout. false by default.
the access control list for this server. See the ACL
class from the main dRuby distribution.
the maximum message size in bytes accepted by the server. Defaults to 25 MB (26214400).
the maximum number of arguments to a remote method accepted by the server. Defaults to 256.
The safe level of the DRbServer. The attribute sets $SAFE for methods performed in the main_loop. Defaults to 0.
The default values of these options can be modified on a class-wide basis by the class methods default_argc_limit, default_load_limit, default_acl, default_id_conv, and verbose=
If config_or_acl
is not a hash, but is not nil, it is assumed to be the access control list for this server. See the :tcp_acl option for more details.
If no other server is currently set as the primary server, this will become the primary server.
The server will immediately start running in its own thread.
# File drb/drb.rb, line 1393 def initialize(uri=nil, front=nil, config_or_acl=nil) if Hash === config_or_acl config = config_or_acl.dup else acl = config_or_acl || @@acl config = { :tcp_acl => acl } end @config = self.class.make_config(config) @protocol = DRbProtocol.open_server(uri, @config) @uri = @protocol.uri @exported_uri = [@uri] @front = front @idconv = @config[:idconv] @safe_level = @config[:safe_level] @grp = ThreadGroup.new @thread = run DRb.regist_server(self) end
Is this server alive?
# File drb/drb.rb, line 1455 def alive? @thread.alive? end
Check that a method is callable via dRuby.
obj
is the object we want to invoke the method on. msg_id
is the method name, as a Symbol.
If the method is an insecure method (see insecure_method?) a SecurityError is thrown. If the method is private or undefined, a NameError is thrown.
# File drb/drb.rb, line 1536 def check_insecure_method(obj, msg_id) return true if Proc === obj && msg_id == :__drb_yield raise(ArgumentError, "#{any_to_s(msg_id)} is not a symbol") unless Symbol == msg_id.class raise(SecurityError, "insecure method `#{msg_id}'") if insecure_method?(msg_id) if obj.private_methods.include?(msg_id) desc = any_to_s(obj) raise NoMethodError, "private method `#{msg_id}' called for #{desc}" elsif obj.protected_methods.include?(msg_id) desc = any_to_s(obj) raise NoMethodError, "protected method `#{msg_id}' called for #{desc}" else true end end
Is uri
the URI for this server?
# File drb/drb.rb, line 1460 def here?(uri) @exported_uri.include?(uri) end
Stop this server.
# File drb/drb.rb, line 1465 def stop_service DRb.remove_server(self) if Thread.current['DRb'] && Thread.current['DRb']['server'] == self Thread.current['DRb']['stop_service'] = true else if @protocol.respond_to? :shutdown @protocol.shutdown else [@thread, *@grp.list].each {|thread| thread.kill} # xxx: Thread#kill end @thread.join end end
Convert a local object to a dRuby reference.
# File drb/drb.rb, line 1487 def to_id(obj) return nil if obj.__id__ == front.__id__ @idconv.to_id(obj) end
Convert a dRuby reference to the local object it refers to.
# File drb/drb.rb, line 1480 def to_obj(ref) return front if ref.nil? return front[ref.to_s] if DRbURIOption === ref @idconv.to_obj(ref) end