Module: DRb

Defined in:
lib/drb/eq.rb,
lib/drb/gw.rb,
lib/drb/drb.rb,
lib/drb/ssl.rb,
lib/drb/unix.rb,
lib/drb/extserv.rb,
lib/drb/observer.rb,
lib/drb/extservm.rb,
lib/drb/timeridconv.rb,
lib/drb/invokemethod.rb

Overview

frozen_string_literal: false for ruby-1.8.0

Defined Under Namespace

Modules: DRbObservable, DRbProtocol, DRbUndumped Classes: DRbArray, DRbBadScheme, DRbBadURI, DRbConn, DRbConnError, DRbError, DRbIdConv, DRbMessage, DRbObject, DRbRemoteError, DRbSSLSocket, DRbServer, DRbServerNotFound, DRbTCPSocket, DRbUNIXSocket, DRbURIOption, DRbUnknown, DRbUnknownError, ExtServ, ExtServManager, GW, GWIdConv, TimerIdConv

Class Method Summary collapse

Class Method Details

.configObject

Get the configuration of the current server.

If there is no current server, this returns the default configuration. See #current_server and DRbServer::make_config.


1758
1759
1760
1761
1762
# File 'lib/drb/drb.rb', line 1758

def config
  current_server.config
rescue
  DRbServer.make_config
end

.current_serverObject

Get the 'current' server.

In the context of execution taking place within the main thread of a dRuby server (typically, as a result of a remote call on the server or one of its objects), the current server is that server. Otherwise, the current server is the primary server.

If the above rule fails to find a server, a DRbServerNotFound error is raised.

Raises:


1715
1716
1717
1718
1719
1720
# File 'lib/drb/drb.rb', line 1715

def current_server
  drb = Thread.current['DRb']
  server = (drb && drb['server']) ? drb['server'] : @primary_server
  raise DRbServerNotFound unless server
  return server
end

.fetch_server(uri) ⇒ Object

Retrieves the server with the given uri.

See also regist_server and remove_server.


1855
1856
1857
# File 'lib/drb/drb.rb', line 1855

def fetch_server(uri)
  @server[uri]
end

.frontObject

Get the front object of the current server.

This raises a DRbServerNotFound error if there is no current server. See #current_server.


1769
1770
1771
# File 'lib/drb/drb.rb', line 1769

def front
  current_server.front
end

.here?(uri) ⇒ Boolean

Is uri the URI for the current local server?

Returns:

  • (Boolean)

1748
1749
1750
1751
# File 'lib/drb/drb.rb', line 1748

def here?(uri)
  current_server.here?(uri) rescue false
  # (current_server.uri rescue nil) == uri
end

.install_acl(acl) ⇒ Object

Set the default ACL to acl.

See DRb::DRbServer.default_acl.


1814
1815
1816
# File 'lib/drb/drb.rb', line 1814

def install_acl(acl)
  DRbServer.default_acl(acl)
end

.install_id_conv(idconv) ⇒ Object

Set the default id conversion object.

This is expected to be an instance such as DRb::DRbIdConv that responds to #to_id and #to_obj that can convert objects to and from DRb references.

See DRbServer#default_id_conv.


1806
1807
1808
# File 'lib/drb/drb.rb', line 1806

def install_id_conv(idconv)
  DRbServer.default_id_conv(idconv)
end

.mutexObject

:nodoc:


1820
1821
1822
# File 'lib/drb/drb.rb', line 1820

def mutex # :nodoc:
  @mutex
end

.primary_serverObject

The primary local dRuby server.

This is the server created by the #start_service call.


1702
1703
1704
# File 'lib/drb/drb.rb', line 1702

def primary_server
  @primary_server
end

.primary_server=(value) ⇒ Object

The primary local dRuby server.

This is the server created by the #start_service call.


1702
1703
1704
# File 'lib/drb/drb.rb', line 1702

def primary_server=(value)
  @primary_server = value
end

.regist_server(server) ⇒ Object

Registers server with DRb.

This is called when a new DRb::DRbServer is created.

If there is no primary server then server becomes the primary server.

Example:

require 'drb'

s = DRb::DRbServer.new # automatically calls regist_server
DRb.fetch_server s.uri #=> #<DRb::DRbServer:0x...>

1838
1839
1840
1841
1842
1843
# File 'lib/drb/drb.rb', line 1838

def regist_server(server)
  @server[server.uri] = server
  mutex.synchronize do
    @primary_server = server unless @primary_server
  end
end

.remove_server(server) ⇒ Object

Removes server from the list of registered servers.


1847
1848
1849
# File 'lib/drb/drb.rb', line 1847

def remove_server(server)
  @server.delete(server.uri)
end

.start_service(uri = nil, front = nil, config = nil) ⇒ Object

Start a dRuby server locally.

The new dRuby server will become the primary server, even if another server is currently the primary server.

uri is the URI for the server to bind to. If nil, the server will bind to random port on the default local host name and use the default dRuby protocol.

front is the server's front object. This may be nil.

config is the configuration for the new server. This may be nil.

See DRbServer::new.


1694
1695
1696
# File 'lib/drb/drb.rb', line 1694

def start_service(uri=nil, front=nil, config=nil)
  @primary_server = DRbServer.new(uri, front, config)
end

.stop_serviceObject

Stop the local dRuby server.

This operates on the primary server. If there is no primary server currently running, it is a noop.


1727
1728
1729
1730
# File 'lib/drb/drb.rb', line 1727

def stop_service
  @primary_server.stop_service if @primary_server
  @primary_server = nil
end

.threadObject

Get the thread of the primary server.

This returns nil if there is no primary server. See #primary_server.


1795
1796
1797
# File 'lib/drb/drb.rb', line 1795

def thread
  @primary_server ? @primary_server.thread : nil
end

.to_id(obj) ⇒ Object

Get a reference id for an object using the current server.

This raises a DRbServerNotFound error if there is no current server. See #current_server.


1786
1787
1788
# File 'lib/drb/drb.rb', line 1786

def to_id(obj)
  current_server.to_id(obj)
end

.to_obj(ref) ⇒ Object

Convert a reference into an object using the current server.

This raises a DRbServerNotFound error if there is no current server. See #current_server.


1778
1779
1780
# File 'lib/drb/drb.rb', line 1778

def to_obj(ref)
  current_server.to_obj(ref)
end

.uriObject

Get the URI defining the local dRuby space.

This is the URI of the current server. See #current_server.


1736
1737
1738
1739
1740
1741
1742
1743
1744
# File 'lib/drb/drb.rb', line 1736

def uri
  drb = Thread.current['DRb']
  client = (drb && drb['client'])
  if client
    uri = client.uri
    return uri if uri
  end
  current_server.uri
end