.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Tirex::Status 3pm"
.TH Tirex::Status 3pm "2023-04-11" "perl v5.36.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Tirex::Status \- Status of running master daemon in shared memory
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
my \f(CW$status\fR = Tirex::Status\->\fBnew()\fR;
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This package manages the status of the master daemon in shared memory.
.SH "METHODS"
.IX Header "METHODS"
.SS "Tirex::Status\->new( master => 1 );"
.IX Subsection "Tirex::Status->new( master => 1 );"
If 'master' is true the shared memory is created (and destroyed afterwards).
Only the master server should do this.
.ie n .SS "$status\->\fBdestroy()\fP"
.el .SS "\f(CW$status\fP\->\fBdestroy()\fP"
.IX Subsection "$status->destroy()"
Destroy shared memory segment.
.ie n .SS "$status\->update(key1 => val1, key2 => val2, ...)"
.el .SS "\f(CW$status\fP\->update(key1 => val1, key2 => val2, ...)"
.IX Subsection "$status->update(key1 => val1, key2 => val2, ...)"
Update shared memory with current status. Call with
key-value pairs that should be added to status.
.ie n .SS "$status\->write($string)"
.el .SS "\f(CW$status\fP\->write($string)"
.IX Subsection "$status->write($string)"
Write a string into shared memory.
.ie n .SS "$status\->\fBread()\fP"
.el .SS "\f(CW$status\fP\->\fBread()\fP"
.IX Subsection "$status->read()"
Read a string from shared memory.
.PP
Returns the string read, or undef if the shared memory was not accessible.