| Class | DRb::DRbServer |
| In: |
drb/invokemethod.rb
drb/drb.rb |
| Parent: | Object |
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.
Constants
| INSECURE_METHOD | = | [ :__send__ |
List of insecure methods.
These methods are not callable via dRuby. |
Attributes
| config | [R] | The configuration of this DRbServer |
| front | [R] |
The front object of the DRbServer.
This object receives remote method calls made on the server’s URI alone, with an object id. |
| safe_level | [R] | |
| thread | [R] |
The main thread of this DRbServer.
This is the thread that listens for and accepts connections from clients, not that handles each client’s request-response session. |
| uri | [R] | The URI of this DRbServer. |
Public Class methods
# File drb/drb.rb, line 1253
1253: def self.default_safe_level(level)
1254: @@safe_level = level
1255: 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:
| :idconv : | an id-to-object conversion object. This defaults to an instance of the class DRb::DRbIdConv. |
| :verbose : | if true, all unsuccessful remote calls on objects in the server will be logged to $stdout. false by default. |
| :tcp_acl : | the access control list for this server. See the ACL class from the main dRuby distribution. |
| :load_limit : | the maximum message size in bytes accepted by the server. Defaults to 25 MB (26214400). |
| :argc_limit : | the maximum number of arguments to a remote method accepted by the server. Defaults to 256. |
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 1324
1324: def initialize(uri=nil, front=nil, config_or_acl=nil)
1325: if Hash === config_or_acl
1326: config = config_or_acl.dup
1327: else
1328: acl = config_or_acl || @@acl
1329: config = {
1330: :tcp_acl => acl
1331: }
1332: end
1333:
1334: @config = self.class.make_config(config)
1335:
1336: @protocol = DRbProtocol.open_server(uri, @config)
1337: @uri = @protocol.uri
1338:
1339: @front = front
1340: @idconv = @config[:idconv]
1341: @safe_level = @config[:safe_level]
1342:
1343: @grp = ThreadGroup.new
1344: @thread = run
1345:
1346: DRb.regist_server(self)
1347: end
Get the default value of the :verbose option.
# File drb/drb.rb, line 1265
1265: def self.verbose
1266: @@verbose
1267: end
Public Instance methods
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 1464
1464: def check_insecure_method(obj, msg_id)
1465: return true if Proc === obj && msg_id == :__drb_yield
1466: raise(ArgumentError, "#{any_to_s(msg_id)} is not a symbol") unless Symbol == msg_id.class
1467: raise(SecurityError, "insecure method `#{msg_id}'") if insecure_method?(msg_id)
1468:
1469: if obj.private_methods.include?(msg_id.to_s)
1470: desc = any_to_s(obj)
1471: raise NoMethodError, "private method `#{msg_id}' called for #{desc}"
1472: elsif obj.protected_methods.include?(msg_id.to_s)
1473: desc = any_to_s(obj)
1474: raise NoMethodError, "protected method `#{msg_id}' called for #{desc}"
1475: else
1476: true
1477: end
1478: end
Stop this server.
# File drb/drb.rb, line 1386
1386: def stop_service
1387: DRb.remove_server(self)
1388: if Thread.current['DRb'] && Thread.current['DRb']['server'] == self
1389: Thread.current['DRb']['stop_service'] = true
1390: else
1391: @thread.kill
1392: end
1393: end
Convert a local object to a dRuby reference.
# File drb/drb.rb, line 1403
1403: def to_id(obj)
1404: return nil if obj.__id__ == front.__id__
1405: @idconv.to_id(obj)
1406: end
Convert a dRuby reference to the local object it refers to.
# File drb/drb.rb, line 1396
1396: def to_obj(ref)
1397: return front if ref.nil?
1398: return front[ref.to_s] if DRbURIOption === ref
1399: @idconv.to_obj(ref)
1400: end
Get whether the server is in verbose mode.
In verbose mode, failed calls are logged to stdout.
# File drb/drb.rb, line 1378
1378: def verbose; @config[:verbose]; end