модуль DRb::DRbProtocol

Module управления базовым сетевым протоколом(ами), используемым drb.

По умолчанию drb использует протокол DRbTCPSocket. Другие протоколы могут быть определены. Протокол должен определить следующие методы класса:

[open(uri, config)] Open a client connection to the server at +uri+,
                    using configuration +config+.  Return a protocol
                    instance for this connection.
[open_server(uri, config)] Open a server listening at +uri+,
                           using configuration +config+.  Return a
                           protocol instance for this listener.
[uri_option(uri, config)] Take a URI, possibly containing an option
                          component (e.g. a trailing '?param=val'),
                          and return a [uri, option] tuple.

Все эти методы должны вызывать ошибку DRbBadScheme, если URI не идентифицирует протокол, который они поддерживают (например, «druby:» для стандартного протокола Ruby). Таким образом, модуль DRbProtocol, получив URI, определяет, какая реализация протокола обслуживает этот протокол.

Экземпляр протокола, возвращаемый open_server, должен иметь следующие методы:

accept: Принимает новое подключение к серверу. Возвращает экземпляр протокола, способный взаимодействовать с клиентом.
close: Закрывает подключение сервера.
uri: Получает URI для этого сервера.

Экземпляр протокола, возвращаемый open, должен иметь следующие методы:

send_request (ref, msg_id, arg, b): Отправляет запрос на ref с заданным идентификатором сообщения и аргументами. Это наиболее просто реализуется путем вызова DRbMessage.send_request, предоставляя поток, который находится поверх текущего протокола.
recv_reply: Получает ответ от сервера и возвращает его как пару [успех-логическое значение, ответ-значение]. Это наиболее просто реализуется путем вызова DRb.recv_reply, предоставляя поток, который находится поверх текущего протокола.
alive?: Это соединение все еще активное?
close: Закрыть это соединение.

Экземпляр протокола, возвращаемый open_server().accept(), должен иметь следующие методы:

recv_request: Получает запрос от клиента и возвращает кортеж [объект, сообщение, аргументы, блок]. Это наиболее просто реализуется путем вызова DRbMessage.recv_request, предоставляя поток, который находится поверх текущего протокола.
send_reply(succ, result): Отправляет ответ клиенту. Это наиболее просто реализуется путем вызова DRbMessage.send_reply, предоставляя поток, который находится поверх текущего протокола.
close: Закрыть это соединение.

Новый протокол регистрируется в модуле DRbProtocol с помощью метода add_protocol.

Примеры других протоколов см. в DRbUNIXSocket в drb/unix.rb, и HTTP0 в sample/http0.rb и sample/http0serv.rb в полном дистрибутиве drb.

Публичные методы класса

add_protocol(prot) Показать исходный код

# File lib/drb/drb.rb, line 724
def add_protocol(prot)
  @protocol.push(prot)
end

Добавить новый протокол в модуль DRbProtocol.

open(uri, config, first=true) Показать исходный код

# File lib/drb/drb.rb, line 736
def open(uri, config, first=true)
  @protocol.each do |prot|
    begin
      return prot.open(uri, config)
    rescue DRbBadScheme
    rescue DRbConnError
      raise($!)
    rescue
      raise(DRbConnError, "#{uri} - #{$!.inspect}")
    end
  end
  if first && (config[:auto_load] != false)
    auto_load(uri)
    return open(uri, config, false)
  end
  raise DRbBadURI, 'can\'t parse uri:' + uri
end

Открыть клиентское подключение к uri с конфигурацией config.

Модуль DRbProtocol просит каждый зарегистрированный протокол по очереди попробовать открыть URI. Каждый протокол сигнализирует, что он не обрабатывает этот URI, сгенерировав ошибку DRbBadScheme. Если ни один протокол не распознает URI, то генерируется ошибка DRbBadURI. Если протокол принимает URI, но при открытии происходит ошибка, генерируется DRbConnError.

open_server(uri, config, first=true) Показать исходный код

# File lib/drb/drb.rb, line 764
def open_server(uri, config, first=true)
  @protocol.each do |prot|
    begin
      return prot.open_server(uri, config)
    rescue DRbBadScheme
    end
  end
  if first && (config[:auto_load] != false)
    auto_load(uri)
    return open_server(uri, config, false)
  end
  raise DRbBadURI, 'can\'t parse uri:' + uri
end

Открыть сервер, ожидающий подключения по адресу uri с конфигурацией config.

Модуль DRbProtocol просит каждый зарегистрированный протокол по очереди попробовать открыть сервер по адресу URI. Каждый протокол сигнализирует, что он не обрабатывает этот URI, сгенерировав ошибку DRbBadScheme. Если ни один протокол не распознает URI, то генерируется ошибка DRbBadURI. Если протокол принимает URI, но при открытии происходит ошибка, основная ошибка передается вызывающему методу.

uri_option(uri, config, first=true) Показать исходный код

# File lib/drb/drb.rb, line 785
def uri_option(uri, config, first=true)
  @protocol.each do |prot|
    begin
      uri, opt = prot.uri_option(uri, config)
      # opt = nil if opt == ''
      return uri, opt
    rescue DRbBadScheme
    end
  end
  if first && (config[:auto_load] != false)
    auto_load(uri)
    return uri_option(uri, config, false)
  end
  raise DRbBadURI, 'can\'t parse uri:' + uri
end

Разбор uri в пару [uri, опция].

Модуль DRbProtocol просит каждый зарегистрированный протокол по очереди попробовать разобрать URI. Каждый протокол сигнализирует, что он не обрабатывает этот URI, сгенерировав ошибку DRbBadScheme. Если ни один протокол не распознает URI, то генерируется ошибка DRbBadURI.

Приватные методы экземпляра