Spec-Zone.ru › Ruby 3.3

класс Process::Status

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

Объект Process::Status содержит информацию о процессе системы.

Переменная потока $? изначально nil. Некоторые методы присваивают ей объект Process::Status, представляющий процесс системы (работающий или завершенный):

`ruby -e "exit 99"`
stat = $?       # => #<Process::Status: pid 1262862 exit 99>
stat.class      # => Process::Status
stat.to_i       # => 25344
stat.stopped?   # => false
stat.exited?    # => true
stat.exitstatus # => 99

Методы класса

Process::Status.wait(pid = -1, flags = 0) → Process::Status Показать исходный код 
static VALUE
rb_process_status_waitv(int argc, VALUE *argv, VALUE _)
{
    rb_check_arity(argc, 0, 2);

    rb_pid_t pid = -1;
    int flags = 0;

    if (argc >= 1) {
        pid = NUM2PIDT(argv[0]);
    }

    if (argc >= 2) {
        flags = RB_NUM2INT(argv[1]);
    }

    return rb_process_status_wait(pid, flags);
}

Аналогично Process.wait, но возвращает объект Process::Status (вместо целочисленного pid или nil); см. Process.wait для значений pid и flags.

Если есть дочерние процессы, ожидает завершения дочернего процесса и возвращает объект Process::Status, содержащий информацию об этом процессе; устанавливает переменную потока $?:

Process.spawn('cat /nop') # => 1155880
Process::Status.wait      # => #<Process::Status: pid 1155880 exit 1>
$?                        # => #<Process::Status: pid 1155508 exit 1>

Если нет дочерних процессов, возвращает “пустой” объект Process::Status, который не представляет фактический процесс; не устанавливает переменную потока $?:

Process::Status.wait # => #<Process::Status: pid -1 exit 0>
$?                   # => #<Process::Status: pid 1155508 exit 1> # Unchanged.

Может вызвать обработчик планировщика Fiber::Scheduler#process_wait.

Недоступно на всех платформах.

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

stat & mask → целое Показать исходный код 
static VALUE
pst_bitand(VALUE st1, VALUE st2)
{
    int status = PST2INT(st1);
    int mask = NUM2INT(st2);

    if (mask < 0) {
        rb_raise(rb_eArgError, "negative mask value: %d", mask);
    }
#define WARN_SUGGEST(suggest) \
    rb_warn_deprecated_to_remove_at(3.4, "Process::Status#&", suggest)

    switch (mask) {
      case 0x80:
        WARN_SUGGEST("Process::Status#coredump?");
        break;
      case 0x7f:
        WARN_SUGGEST("Process::Status#signaled? or Process::Status#termsig");
        break;
      case 0xff:
        WARN_SUGGEST("Process::Status#exited?, Process::Status#stopped? or Process::Status#coredump?");
        break;
      case 0xff00:
        WARN_SUGGEST("Process::Status#exitstatus or Process::Status#stopsig");
        break;
      default:
        WARN_SUGGEST("other Process::Status predicates");
        break;
    }
#undef WARN_SUGGEST
    status &= mask;

    return INT2NUM(status);
}

Этот метод устарел, так как значение to_i зависит от системы; используйте предикатные методы, такие как exited? или stopped?, или геттеры, такие как exitstatus или stopsig.

Возвращает логическое И значения to_i с mask. 

`cat /nop`
stat = $?                 # => #<Process::Status: pid 1155508 exit 1>
sprintf('%x', stat.to_i)  # => "100"
stat & 0x00               # => 0

ArgumentError генерируется, если mask отрицательное.

stat == other → true или false Показать исходный код 
static VALUE
pst_equal(VALUE st1, VALUE st2)
{
    if (st1 == st2) return Qtrue;
    return rb_equal(pst_to_i(st1), st2);
}

Возвращает значение истинности, если значение to_i == other:

`cat /nop`
stat = $?                # => #<Process::Status: pid 1170366 exit 1>
sprintf('%x', stat.to_i) # => "100"
stat == 0x100            # => true
stat >> places → целое Показать исходный код 
static VALUE
pst_rshift(VALUE st1, VALUE st2)
{
    int status = PST2INT(st1);
    int places = NUM2INT(st2);

    if (places < 0) {
        rb_raise(rb_eArgError, "negative shift value: %d", places);
    }
#define WARN_SUGGEST(suggest) \
    rb_warn_deprecated_to_remove_at(3.4, "Process::Status#>>", suggest)

    switch (places) {
      case 7:
        WARN_SUGGEST("Process::Status#coredump?");
        break;
      case 8:
        WARN_SUGGEST("Process::Status#exitstatus or Process::Status#stopsig");
        break;
      default:
        WARN_SUGGEST("other Process::Status attributes");
        break;
    }
#undef WARN_SUGGEST
    status >>= places;

    return INT2NUM(status);
}

Этот метод устарел, так как значение to_i зависит от системы; используйте предикатные методы, такие как exited? или stopped?, или геттеры, такие как exitstatus или stopsig.

Возвращает значение to_i, сдвинутое вправо на places:

`cat /nop`
stat = $?                 # => #<Process::Status: pid 1155508 exit 1>
stat.to_i                 # => 256
stat >> 1                 # => 128
stat >> 2                 # => 64

ArgumentError генерируется, если places отрицательное.

coredump? → true или false Показать исходный код 
static VALUE
pst_wcoredump(VALUE st)
{
#ifdef WCOREDUMP
    int status = PST2INT(st);

    return RBOOL(WCOREDUMP(status));
#else
    return Qfalse;
#endif
}

Возвращает true, если процесс сгенерировал дамп ядра при завершении, false, если нет.

Не доступно на всех платформах.

exited? → true или false Показать исходный код 
static VALUE
pst_wifexited(VALUE st)
{
    int status = PST2INT(st);

    return RBOOL(WIFEXITED(status));
}

Возвращает true, если процесс завершился нормально (например, с помощью вызова exit(), или завершения программы), false, если нет.

exitstatus → целое или nil Показать исходный код 
static VALUE
pst_wexitstatus(VALUE st)
{
    int status = PST2INT(st);

    if (WIFEXITED(status))
        return INT2NUM(WEXITSTATUS(status));
    return Qnil;
}

Возвращает наименее значимые восемь бит кода возврата процесса, если он завершился; nil в противном случае:

`exit 99`
$?.exitstatus # => 99
inspect → строка Показать исходный код 
static VALUE
pst_inspect(VALUE st)
{
    rb_pid_t pid;
    int status;
    VALUE str;

    pid = pst_pid(st);
    if (!pid) {
        return rb_sprintf("#<%s: uninitialized>", rb_class2name(CLASS_OF(st)));
    }
    status = PST2INT(st);

    str = rb_sprintf("#<%s: ", rb_class2name(CLASS_OF(st)));
    pst_message(str, pid, status);
    rb_str_cat2(str, ">");
    return str;
}

Возвращает строковое представление self:

system("false")
$?.inspect # => "#<Process::Status: pid 1303494 exit 1>"
pid → целое Показать исходный код 
static VALUE
pst_pid_m(VALUE self)
{
    rb_pid_t pid = pst_pid(self);
    return PIDT2NUM(pid);
}

Возвращает идентификатор процесса:

system("false")
$?.pid # => 1247002
signaled? → true или false Показать исходный код 
static VALUE
pst_wifsignaled(VALUE st)
{
    int status = PST2INT(st);

    return RBOOL(WIFSIGNALED(status));
}

Возвращает true, если процесс завершился из-за необработанного сигнала, false, если нет.

END_OF_DOCUMENT_MARKER
stopped? → true или false Показать исходный код 
static VALUE
pst_wifstopped(VALUE st)
{
    int status = PST2INT(st);

    return RBOOL(WIFSTOPPED(status));
}

Возвращает true, если этот процесс остановлен, и если соответствующий вызов ожидания имел установленный флаг Process::WUNTRACED, и false в противном случае.

stopsig → целое число или nil Показать исходный код 
static VALUE
pst_wstopsig(VALUE st)
{
    int status = PST2INT(st);

    if (WIFSTOPPED(status))
        return INT2NUM(WSTOPSIG(status));
    return Qnil;
}

Возвращает номер сигнала, который привел к остановке процесса, или nil, если процесс не остановлен.

success? → true, false или nil Показать исходный код 
static VALUE
pst_success_p(VALUE st)
{
    int status = PST2INT(st);

    if (!WIFEXITED(status))
        return Qnil;
    return RBOOL(WEXITSTATUS(status) == EXIT_SUCCESS);
}

Возвращает:

  • true, если процесс успешно завершился и вышел.

  • false, если процесс завершился неудачно и вышел.

  • nil, если процесс не завершился.

termsig → целое число или nil Показать исходный код 
static VALUE
pst_wtermsig(VALUE st)
{
    int status = PST2INT(st);

    if (WIFSIGNALED(status))
        return INT2NUM(WTERMSIG(status));
    return Qnil;
}

Возвращает номер сигнала, который привел к завершению процесса, или nil, если процесс не был завершен неуловленным сигналом.

to_i → целое число Показать исходный код 
static VALUE
pst_to_i(VALUE self)
{
    int status = pst_status(self);
    return RB_INT2NUM(status);
}

Возвращает зависящий от системы целочисленный статус процесса:

`cat /nop`
$?.to_i # => 256
to_s → строка Показать исходный код 
static VALUE
pst_to_s(VALUE st)
{
    rb_pid_t pid;
    int status;
    VALUE str;

    pid = pst_pid(st);
    status = PST2INT(st);

    str = rb_str_buf_new(0);
    pst_message(str, pid, status);
    return str;
}

Возвращает строковое представление процесса:

`cat /nop`
$?.to_s # => "pid 1262141 exit 1"

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

Spec-Zone.ru

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