.\" 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 "Message::Passing::Role::HasAConnection 3pm"
.TH Message::Passing::Role::HasAConnection 3pm "2017-08-02" "perl v5.26.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"
Message::Passing::Role::HasAConnection \- Role for components which have a connection
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Provides a standard \->connection_manager attribute for inputs or outputs which need to
make a network connection before they can send or receive messages.
.PP
The connection manager object is assumed to have the \f(CW\*(C`\->subscribe_to_connect\*(C'\fR method
(from Message::Passing::Role::Connection).
.SH "REQUIRED METHODS"
.IX Header "REQUIRED METHODS"
.SS "_build_connection_manager"
.IX Subsection "_build_connection_manager"
Will be called at \s-1BUILD\s0 (i.e. object construction) time, should return
a connection manager object (i.e. an object that \f(CW\*(C`\->subscribe_to_connect\*(C'\fR
can be called on).
.SS "connected ($client)"
.IX Subsection "connected ($client)"
Called by the connection manager when a connection is made.
.PP
Usually used to do things like subscribe to queues..
.SH "OPTIONAL METHODS"
.IX Header "OPTIONAL METHODS"
.SS "disconnected ($client)"
.IX Subsection "disconnected ($client)"
The client received an error or otherwise disconnected.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.SS "connection_manager"
.IX Subsection "connection_manager"
Holds the connection manger returned by the \f(CW\*(C`_build_connection_manager\*(C'\fR method.
.SH "WRAPPED METHODS"
.IX Header "WRAPPED METHODS"
.SS "\s-1BUILD\s0"
.IX Subsection "BUILD"
Is wrapped to build the connection manager object.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "Message::Passing::Role::ConenctionManager." 4
.IX Item "Message::Passing::Role::ConenctionManager."
.SH "SPONSORSHIP"
.IX Header "SPONSORSHIP"
This module exists due to the wonderful people at Suretec Systems Ltd.
<http://www.suretecsystems.com/> who sponsored its development for its
VoIP division called SureVoIP <http://www.surevoip.co.uk/> for use with
the SureVoIP \s-1API\s0 \- 
<http://www.surevoip.co.uk/support/wiki/api_documentation>
.SH "AUTHOR, COPYRIGHT AND LICENSE"
.IX Header "AUTHOR, COPYRIGHT AND LICENSE"
See Message::Passing.