Spec-Zone.ru › Ruby 2.3

класс DRb::DRbServer

Родитель:
Объект

Класс, представляющий экземпляр сервера drb.

Сервер DRbServer должен быть запущен в локальном процессе, прежде чем можно будет принять входящие вызовы dRuby или передать локальные объекты как ссылки dRuby в удаленные процессы, даже если эти локальные объекты никогда фактически не вызываются удалённо. Вам не нужно запускать DRbServer в локальном процессе, если вы только делаете исходящие вызовы dRuby, передавая закодированные параметры.

Если не используются несколько серверов, локальный DRbServer обычно запускается путём вызова DRb#start_service.

Константы

INSECURE_METHOD

Список небезопасных методов.

Эти методы недоступны для вызова через dRuby.

Атрибуты

config[R]

Настройка данного DRbServer

front[R]

Объект front сервера DRbServer.

Этот объект получает удалённые вызовы методов, сделанные для URI сервера URI в одиночку, с идентификатором объекта.

safe_level[R]

Уровень безопасности для этого сервера. Это число, соответствующее $SAFE.

По умолчанию #safe_level равен 0.

thread[R]

Основной поток данного DRbServer.

Это поток, который прослушивает и принимает подключения от клиентов, а не обрабатывает сеанс запроса-ответа для каждого клиента.

uri[R]

URI данного DRbServer.

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

default_acl(acl) Показать исходный код
# File lib/drb/drb.rb, line 1305
def self.default_acl(acl)
  @@acl = acl
end

Установить список контроля доступа по умолчанию на acl. Список контроля доступа по умолчанию (ACL) — nil.

См. также DRb::ACL и new()

default_argc_limit(argc) Показать исходный код
# File lib/drb/drb.rb, line 1291
def self.default_argc_limit(argc)
  @@argc_limit = argc
end

Установить значение по умолчанию для параметра :argc_limit.

См. new(). Начальное значение по умолчанию — 256.

default_id_conv(idconv) Показать исходный код
# File lib/drb/drb.rb, line 1312
def self.default_id_conv(idconv)
  @@idconv = idconv
end

Установить значение по умолчанию для параметра :id_conv.

См. new(). Начальное значение по умолчанию — экземпляр DRbIdConv.

default_load_limit(sz) Показать исходный код
# File lib/drb/drb.rb, line 1298
def self.default_load_limit(sz)
  @@load_limit = sz
end

Установить значение по умолчанию для параметра :load_limit.

См. new(). Начальное значение по умолчанию — 25 МБ.

default_safe_level(level) Показать исходный код
# File lib/drb/drb.rb, line 1319
def self.default_safe_level(level)
  @@safe_level = level
end

Установить уровень безопасности по умолчанию на level. Уровень безопасности по умолчанию — 0.

См. new для получения дополнительной информации.

new(uri=nil, front=nil, config_or_acl=nil) Показать исходный код
# File lib/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

Создать новый экземпляр DRbServer.

uri — URI для привязки. Обычно это строка вида 'druby://<hostname>:<port>', где <hostname> — имя хоста локальной машины. Если значение nil, то будет привязано к системному имени хоста по порту, выбранному системой; эти значения можно получить из атрибута uri. 'druby:' указывает на протокол по умолчанию dRuby; вместо него можно указать другой протокол, например, 'drbunix:'.

front — объект front для сервера, то есть объект, которому будут передаваться удалённые вызовы методов на сервере. Если значение nil, сервер не будет принимать удалённые вызовы методов.

Если config_or_acl — хэш, это конфигурация для использования на данном сервере. Распознаются следующие параметры:

:idconv

объект преобразования идентификатора в объект. По умолчанию это экземпляр класса DRb::DRbIdConv.

:verbose

если true, все неудачные удалённые вызовы на объекты на сервере будут регистрироваться в $stdout. По умолчанию false.

:tcp_acl

список контроля доступа для этого сервера. См. класс ACL из основного распространения dRuby.

:load_limit

максимальный размер сообщения в байтах, принимаемый сервером. По умолчанию 25 МБ (26214400).

:argc_limit

максимальное количество аргументов для удалённого метода, принимаемых сервером. По умолчанию 256.

:safe_level

Уровень безопасности DRbServer. Атрибут устанавливает $SAFE для методов, выполняемых в main_loop. По умолчанию 0.

Значения по умолчанию для этих параметров можно изменить на уровне класса с помощью методов default_argc_limit, default_load_limit, default_acl, default_id_conv и verbose=.

Если config_or_acl не является хэшем, но не nil, предполагается, что это список контроля доступа для этого сервера. См. параметр :tcp_acl для получения дополнительных сведений.

Если в данный момент ни один другой сервер не установлен в качестве основного, этот сервер станет основным.

Сервер сразу же начнёт работу в собственном потоке.

verbose() Показать исходный код
# File lib/drb/drb.rb, line 1331
def self.verbose
  @@verbose
end

Получить значение по умолчанию параметра :verbose.

verbose=(on) Показать исходный код
# File lib/drb/drb.rb, line 1326
def self.verbose=(on)
  @@verbose = on
end

Установить значение по умолчанию параметра :verbose.

См. new(). Начальное значение по умолчанию — false.

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

alive?() Показать исходный код
# File lib/drb/drb.rb, line 1455
def alive?
  @thread.alive?
end

Является ли сервер активным?

check_insecure_method(obj, msg_id) Показать исходный код
# File lib/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

Проверка возможности вызова метода через dRuby.

obj — объект, на котором нужно вызвать метод. msg_id — имя метода, представленное как символ.

Если метод является небезопасным (см. insecure_method?), выбрасывается исключение SecurityError. Если метод является приватным или не определён, выбрасывается исключение NameError.

here?(uri) Показать исходный код
# File lib/drb/drb.rb, line 1460
def here?(uri)
  @exported_uri.include?(uri)
end

Является ли uri URI этого сервера?

stop_service() Показать исходный код
# File lib/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

Остановка сервера.

to_id(obj) Показать исходный код
# File lib/drb/drb.rb, line 1487
def to_id(obj)
  return nil if obj.__id__ == front.__id__
  @idconv.to_id(obj)
end

Преобразование локального объекта в ссылку dRuby.

to_obj(ref) Показать исходный код
# File lib/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

Преобразование ссылки dRuby в локальный объект, на который она ссылается.

verbose() Показать исходный код
# File lib/drb/drb.rb, line 1452
def verbose; @config[:verbose]; end

Получение режима подробной информации сервера.

В режиме подробной информации не удачные вызовы регистрируются в stdout.

verbose=(v) Показать исходный код
# File lib/drb/drb.rb, line 1447
def verbose=(v); @config[:verbose]=v; end

Установить режим подробной информации.

В режиме подробной информации не удачные вызовы регистрируются в stdout.

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

any_to_s(obj) Показать исходный код
# File lib/drb/drb.rb, line 1522
def any_to_s(obj)
  obj.to_s + ":#{obj.class}"
rescue
  sprintf("#<%s:0x%lx>", obj.class, obj.__id__)
end

Приведение объекта к строковому представлению, предоставляя собственное представление, если для объекта не определён метод to_s.

insecure_method?(msg_id) Показать исходный код
# File lib/drb/drb.rb, line 1516
def insecure_method?(msg_id)
  INSECURE_METHOD.include?(msg_id)
end

Является ли метод включённым в список небезопасных методов?

main_loop() Показать исходный код
# File lib/drb/drb.rb, line 1642
def main_loop
  client0 = @protocol.accept
  return nil if !client0
  Thread.start(client0) do |client|
    @grp.add Thread.current
    Thread.current['DRb'] = { 'client' => client ,
                              'server' => self }
    DRb.mutex.synchronize do
      client_uri = client.uri
      @exported_uri << client_uri unless @exported_uri.include?(client_uri)
    end
    loop do
      begin
        succ = false
        invoke_method = InvokeMethod.new(self, client)
        succ, result = invoke_method.perform
        if !succ && verbose
          p result
          result.backtrace.each do |x|
            puts x
          end
        end
        client.send_reply(succ, result) rescue nil
      ensure
        client.close unless succ
        if Thread.current['DRb']['stop_service']
          Thread.new { stop_service }
        end
        break unless succ
      end
    end
  end
end

Основной цикл, выполняемый внутренней нитью DRbServer.

Принимает соединение от клиента и запускает собственную нить для его обработки. Эта нить циклически получает запросы от клиента, вызывает их на локальном объекте, возвращает ответы, до тех пор, пока клиент не закроет соединение или вызов локального метода не завершится с ошибкой.

run() Показать исходный код
# File lib/drb/drb.rb, line 1497
def run
  Thread.start do
    begin
      while main_loop
      end
    ensure
      @protocol.close if @protocol
    end
  end
end

Запуск основного цикла DRb в новой нити.

Ruby Core © 1993–2017 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API