.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35) .\" .\" 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 .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" ======================================================================== .\" .IX Title "POE::Component::IRC::Cookbook::Disconnecting 3pm" .TH POE::Component::IRC::Cookbook::Disconnecting 3pm "2018-01-01" "perl v5.26.1" "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" POE::Component::IRC::Cookbook::Disconnecting \- How to disconnect gracefully with PoCo\-IRC .SH "SYNOPSIS" .IX Header "SYNOPSIS" Shutting down an \s-1IRC\s0 bot can be quick and messy, or slow and graceful. .SH "DESCRIPTION" .IX Header "DESCRIPTION" There are two ways you can shut down an \s-1IRC\s0 bot/client. The quick and dirty way is rather simple: .PP .Vb 1 \& exit; .Ve .PP It exits the program, shutting down the socket, and everybody online sees yet another \*(L"Connection reset by peer\*(R" or \*(L"Remote end closed the socket\*(R" or something. .PP As of version 6.50, all you need to do in order to shut down gracefully is to send a \f(CW\*(C`shutdown\*(C'\fR event to the \s-1IRC\s0 component. It will make sure your quit message (if any) gets delivered, and will forcibly disconnect if there are any problems (faulty server or network issues). After doing this, it will unregister all sessions and clean up after itself. .PP If you want to do something more elaborate on your own, take a look at the following documentation: logged in, \&\f(CW\*(C`connected\*(C'\fR, \&\f(CW\*(C`quit\*(C'\fR, \&\f(CW\*(C`disconnect\*(C'\fR, and \&\f(CW\*(C`unregister\*(C'\fR. .SH "AUTHOR" .IX Header "AUTHOR" Rocco Caputo and Hinrik Örn Sigurðsson.