diff options
| author | Ingela Anderton Andin <[email protected]> | 2012-11-06 10:55:39 +0100 |
|---|---|---|
| committer | Ingela Anderton Andin <[email protected]> | 2012-12-13 22:33:14 +0100 |
| commit | 671cf55d2388ef3c30f8e0e6b3e5ec824b02da09 (patch) | |
| tree | f44994de421b80cb8c646ce66159b1cf887df969 /lib/ssh/src/ssh_channel.erl | |
| parent | 2084f7e079c951fdadebe23dcff5ec247c6e0158 (diff) | |
| download | otp-671cf55d2388ef3c30f8e0e6b3e5ec824b02da09.tar.gz otp-671cf55d2388ef3c30f8e0e6b3e5ec824b02da09.tar.bz2 otp-671cf55d2388ef3c30f8e0e6b3e5ec824b02da09.zip | |
ssh: Document and clean up SSH behaviours
Diffstat (limited to 'lib/ssh/src/ssh_channel.erl')
| -rw-r--r-- | lib/ssh/src/ssh_channel.erl | 37 |
1 files changed, 29 insertions, 8 deletions
diff --git a/lib/ssh/src/ssh_channel.erl b/lib/ssh/src/ssh_channel.erl index 1938858420..4e8f8538c2 100644 --- a/lib/ssh/src/ssh_channel.erl +++ b/lib/ssh/src/ssh_channel.erl @@ -23,14 +23,35 @@ -include("ssh_connect.hrl"). -%%% Optional callbacks handle_call/3, handle_cast/2, handle_msg/2, -%%% code_change/3 -%% Should be further specified later --callback init(Options::list()) -> - {ok, State::term()} | {ok, State::term(), Timeout::timeout()} | - {stop, Reason ::term()}. - --callback terminate(term(), term()) -> term(). +-callback init(Args :: term()) -> + {ok, State :: term()} | {ok, State :: term(), timeout() | hibernate} | + {stop, Reason :: term()} | ignore. +-callback handle_call(Request :: term(), From :: {pid(), Tag :: term()}, + State :: term()) -> + {reply, Reply :: term(), NewState :: term()} | + {reply, Reply :: term(), NewState :: term(), timeout() | hibernate} | + {noreply, NewState :: term()} | + {noreply, NewState :: term(), timeout() | hibernate} | + {stop, Reason :: term(), Reply :: term(), NewState :: term()} | + {stop, Reason :: term(), NewState :: term()}. +-callback handle_cast(Request :: term(), State :: term()) -> + {noreply, NewState :: term()} | + {noreply, NewState :: term(), timeout() | hibernate} | + {stop, Reason :: term(), NewState :: term()}. + +-callback terminate(Reason :: (normal | shutdown | {shutdown, term()} | + term()), + State :: term()) -> + term(). +-callback code_change(OldVsn :: (term() | {down, term()}), State :: term(), + Extra :: term()) -> + {ok, NewState :: term()} | {error, Reason :: term()}. + +-callback handle_msg(Msg ::term(), State :: term()) -> + {noreply, NewState :: term()} | + {noreply, NewState :: term(), timeout() | hibernate} | + {stop, Reason :: term(), NewState :: term()}. + -callback handle_ssh_msg({ssh_cm, ConnectionRef::term(), SshMsg::term()}, State::term()) -> {ok, State::term()} | |