Add some comments

Signed-off-by: Pedro Melo <melo@simplicidade.org>
This commit is contained in:
Pedro Melo
2014-07-20 17:45:48 +01:00
parent 88b263f0d5
commit 903fe1cbe9

View File

@@ -55,6 +55,9 @@ sub new {
return $self; return $self;
} }
## Connection control
sub connect { sub connect {
my ($self) = @_; my ($self) = @_;
return if $self->{handle}; return if $self->{handle};
@@ -82,7 +85,7 @@ sub connect {
} }
## Protocol ## Protocol API
sub identify { sub identify {
my ($self, @rest) = @_; my ($self, @rest) = @_;
@@ -194,6 +197,7 @@ sub _build_identity_payload {
## Connection setup and cleanup ## Connection setup and cleanup
## After a sucessfull connection, do all tasks expected of the protocol and our users
sub _connected { sub _connected {
my ($self) = @_; my ($self) = @_;
@@ -205,6 +209,7 @@ sub _connected {
$self->{connect_cb}->($self); $self->{connect_cb}->($self);
} }
## Cleanup $self after a disconnect
sub _disconnected { sub _disconnected {
my ($self) = @_; my ($self) = @_;
@@ -212,6 +217,7 @@ sub _disconnected {
delete $self->{$_} for qw(handle connected); delete $self->{$_} for qw(handle connected);
} }
## Try to be as clean as possible but force a disconnect
sub _force_disconnect { sub _force_disconnect {
my ($self) = @_; my ($self) = @_;
return unless my $hdl = $self->{handle}; return unless my $hdl = $self->{handle};
@@ -228,7 +234,7 @@ sub _force_disconnect {
} }
## low-level protocol details ## low-level protocol management
sub _send_magic_identifier { $_[0]{handle}->push_write(' V2') } sub _send_magic_identifier { $_[0]{handle}->push_write(' V2') }