Updated comment for Channel and TcpChannel constructors (to prevent issues like #154)
This commit is contained in:
parent
9ee057b254
commit
60466cc6bf
|
|
@ -29,6 +29,10 @@ private:
|
||||||
public:
|
public:
|
||||||
/**
|
/**
|
||||||
* Construct a channel object
|
* Construct a channel object
|
||||||
|
*
|
||||||
|
* The passed in connection pointer must remain valid for the
|
||||||
|
* lifetime of the channel.
|
||||||
|
*
|
||||||
* @param connection
|
* @param connection
|
||||||
*/
|
*/
|
||||||
Channel(Connection *connection) : _implementation(new ChannelImpl())
|
Channel(Connection *connection) : _implementation(new ChannelImpl())
|
||||||
|
|
|
||||||
|
|
@ -4,7 +4,7 @@
|
||||||
* Extended channel that can be constructed on top of a TCP connection
|
* Extended channel that can be constructed on top of a TCP connection
|
||||||
*
|
*
|
||||||
* @author Emiel Bruijntjes <emiel.bruijntjes@copernica.com>
|
* @author Emiel Bruijntjes <emiel.bruijntjes@copernica.com>
|
||||||
* @copyright 2015 Copernica BV
|
* @copyright 2015 - 2017 Copernica BV
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
@ -25,6 +25,10 @@ class TcpChannel : public Channel
|
||||||
public:
|
public:
|
||||||
/**
|
/**
|
||||||
* Constructor
|
* Constructor
|
||||||
|
*
|
||||||
|
* The passed in connection pointer must remain valid for the
|
||||||
|
* lifetime of the channel.
|
||||||
|
*
|
||||||
* @param connection
|
* @param connection
|
||||||
*/
|
*/
|
||||||
TcpChannel(TcpConnection *connection) :
|
TcpChannel(TcpConnection *connection) :
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue