The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Zing::Cartridge - Executable Process File

ABSTRACT

Executable Process File Abstraction

SYNOPSIS

  use Zing::Cartridge;

  my $cartridge = Zing::Cartridge->new(name => 'myapp');

  # $cartridge->pid;

DESCRIPTION

This package provides an executable process file abstraction.

INHERITS

This package inherits behaviors from:

Zing::Entity

LIBRARIES

This package uses type constraints from:

Zing::Types

ATTRIBUTES

This package has the following attributes:

appdir

  appdir(Str)

This attribute is read-only, accepts (Str) values, and is optional.

appfile

  appfile(Str)

This attribute is read-only, accepts (Str) values, and is optional.

libdir

  libdir(ArrayRef[Str])

This attribute is read-only, accepts (ArrayRef[Str]) values, and is optional.

name

  name(Str)

This attribute is read-only, accepts (Str) values, and is optional.

piddir

  piddir(Str)

This attribute is read-only, accepts (Str) values, and is optional.

pidfile

  pidfile(Str)

This attribute is read-only, accepts (Str) values, and is optional.

scheme

  scheme(Scheme)

This attribute is read-only, accepts (Scheme) values, and is optional.

METHODS

This package implements the following methods:

install

  install(Scheme $scheme) : Object

The install method creates an executable process file on disk for the scheme provided.

install example #1
  # given: synopsis

  $cartridge = $cartridge->install(['MyApp', [], 1]);
install example #2
  use Zing::Cartridge;

  my $cartridge = Zing::Cartridge->new(scheme => ['MyApp', [], 1]);

  $cartridge = $cartridge->install;

pid

  pid() : Maybe[Int]

The pid method returns the process ID of the executed process (if any).

pid example #1
  # given: synopsis

  my $pid = $cartridge->pid;

AUTHOR

Al Newkirk, awncorp@cpan.org

LICENSE

Copyright (C) 2011-2019, Al Newkirk, et al.

This is free software; you can redistribute it and/or modify it under the terms of the The Apache License, Version 2.0, as elucidated in the "license file".

PROJECT

Wiki

Project

Initiatives

Milestones

Contributing

Issues