Class: DRb::DRbServer

Inherits:
Object
  • Object
show all
Defined in:
lib/drb/drb.rb,
lib/drb/invokemethod.rb

Overview

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.

Defined Under Namespace

Modules: InvokeMethod18Mixin Classes: InvokeMethod

Constant Summary collapse

INSECURE_METHOD =

List of insecure methods.

These methods are not callable via dRuby.

[
  :__send__
]
@@acl = 
nil
@@idconv = 
DRbIdConv.new
@@secondary_server = 
nil
@@argc_limit = 
256
@@load_limit = 
256 * 102400
@@verbose = 
false
@@safe_level = 
0

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(uri = nil, front = nil, config_or_acl = nil) ⇒ DRbServer

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.



1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
 
# File 'lib/drb/drb.rb', line 1328

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

  @front = front
  @idconv = @config[:idconv]
  @safe_level = @config[:safe_level]

  @grp = ThreadGroup.new
  @thread = run

  DRb.regist_server(self)
end

Instance Attribute Details

#config ⇒ Object (readonly)

The configuration of this DRbServer



1370
1371
1372
 
# File 'lib/drb/drb.rb', line 1370

def config
  @config
end

#front ⇒ Object (readonly)

The front object of the DRbServer.

This object receives remote method calls made on the server's URI alone, with an object id.



1367
1368
1369
 
# File 'lib/drb/drb.rb', line 1367

def front
  @front
end

#safe_level ⇒ Object (readonly)

Returns the value of attribute safe_level



1372
1373
1374
 
# File 'lib/drb/drb.rb', line 1372

def safe_level
  @safe_level
end

#thread ⇒ Object (readonly)

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.



1361
1362
1363
 
# File 'lib/drb/drb.rb', line 1361

def thread
  @thread
end

#uri ⇒ Object (readonly)

The URI of this DRbServer.



1354
1355
1356
 
# File 'lib/drb/drb.rb', line 1354

def uri
  @uri
end

Class Method Details

.default_acl(acl) ⇒ Object

Set the default value for the :acl option.

See #new(). The initial default value is nil.



1246
1247
1248
 
# File 'lib/drb/drb.rb', line 1246

def self.default_acl(acl)
  @@acl = acl
end

.default_argc_limit(argc) ⇒ Object

Set the default value for the :argc_limit option.

See #new(). The initial default value is 256.



1232
1233
1234
 
# File 'lib/drb/drb.rb', line 1232

def self.default_argc_limit(argc)
  @@argc_limit = argc
end

.default_id_conv(idconv) ⇒ Object

Set the default value for the :id_conv option.

See #new(). The initial default value is a DRbIdConv instance.



1253
1254
1255
 
# File 'lib/drb/drb.rb', line 1253

def self.default_id_conv(idconv)
  @@idconv = idconv
end

.default_load_limit(sz) ⇒ Object

Set the default value for the :load_limit option.

See #new(). The initial default value is 25 MB.



1239
1240
1241
 
# File 'lib/drb/drb.rb', line 1239

def self.default_load_limit(sz)
  @@load_limit = sz
end

.default_safe_level(level) ⇒ Object 



1257
1258
1259
 
# File 'lib/drb/drb.rb', line 1257

def self.default_safe_level(level)
  @@safe_level = level
end

.make_config(hash = {}) ⇒ Object

:nodoc:



1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
 
# File 'lib/drb/drb.rb', line 1273

def self.make_config(hash={})  # :nodoc:
  default_config = { 
	:idconv => @@idconv,
	:verbose => @@verbose,
	:tcp_acl => @@acl,
	:load_limit => @@load_limit,
	:argc_limit => @@argc_limit,
    :safe_level => @@safe_level
  }
  default_config.update(hash)
end

.verbose ⇒ Object

Get the default value of the :verbose option.



1269
1270
1271
 
# File 'lib/drb/drb.rb', line 1269

def self.verbose
  @@verbose
end

.verbose=(on) ⇒ Object

Set the default value of the :verbose option.

See #new(). The initial default value is false.



1264
1265
1266
 
# File 'lib/drb/drb.rb', line 1264

def self.verbose=(on)
  @@verbose = on
end

Instance Method Details

#alive? ⇒ Boolean

Is this server alive?

Returns:

  • (Boolean) 


1385
1386
1387
 
# File 'lib/drb/drb.rb', line 1385

def alive?
  @thread.alive?
end

#check_insecure_method(obj, msg_id) ⇒ Object

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.

Raises:

  • (ArgumentError) 


1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
 
# File 'lib/drb/drb.rb', line 1468

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.to_s)
	desc = any_to_s(obj)
    raise NoMethodError, "private method `#{msg_id}' called for #{desc}"
  elsif obj.protected_methods.include?(msg_id.to_s)
	desc = any_to_s(obj)
    raise NoMethodError, "protected method `#{msg_id}' called for #{desc}"
  else
    true
  end
end

#stop_service ⇒ Object

Stop this server.



1390
1391
1392
1393
1394
1395
1396
1397
 
# File 'lib/drb/drb.rb', line 1390

def stop_service
  DRb.remove_server(self)
  if  Thread.current['DRb'] && Thread.current['DRb']['server'] == self
    Thread.current['DRb']['stop_service'] = true
  else
    @thread.kill
  end
end

#to_id(obj) ⇒ Object

Convert a local object to a dRuby reference.



1407
1408
1409
1410
 
# File 'lib/drb/drb.rb', line 1407

def to_id(obj)
  return nil if obj.__id__ == front.__id__
  @idconv.to_id(obj)
end

#to_obj(ref) ⇒ Object

Convert a dRuby reference to the local object it refers to.



1400
1401
1402
1403
1404
 
# File 'lib/drb/drb.rb', line 1400

def to_obj(ref)
  return front if ref.nil?
  return front[ref.to_s] if DRbURIOption === ref
  @idconv.to_obj(ref)
end

#verbose ⇒ Object

Get whether the server is in verbose mode.

In verbose mode, failed calls are logged to stdout.



1382
 
# File 'lib/drb/drb.rb', line 1382

def verbose; @config[:verbose]; end

#verbose=(v) ⇒ Object

Set whether to operate in verbose mode.

In verbose mode, failed calls are logged to stdout.



1377
 
# File 'lib/drb/drb.rb', line 1377

def verbose=(v); @config[:verbose]=v; end