MESSAGES SENT TO CHANNEL PROCESSES

As a result of the ssh connection protocol messages on the form
{ssh_cm, ssh_connection_ref(), term()}
will be sent to a channel process. The term will contain
information regarding the ssh connection protocol event,
for details see the ssh channel behavior callback handle_ssh_msg/2

adjust_window(ConnectionRef, ChannelId, NumOfBytes) -> ok

ConnectionRef = ssh_connection_ref()

ChannelId = ssh_channel_id()

NumOfBytes = integer()

Adjusts the ssh flowcontrol window.

Note!

This will be taken care of by the ssh_channel
behavior when the callback
handle_ssh_msg/2 has returned after processing a
{ssh_cm, ssh_connection_ref(), {data, ssh_channel_id(),
ssh_data_type_code(), binary()}}
message, and should normally not be called explicitly.

close(ConnectionRef, ChannelId) -> ok

ConnectionRef = ssh_connection_ref()

ChannelId = ssh_channel_id()

Sends a close message on the channel ChannelId

Note!

This function will be called by the ssh channel
behavior when the channel is terminated see ssh_channel(3) and should
normally not be called explicitly.

It is recommended by the ssh connection protocol that this
message shall be sent, but that may not always be the case.

1 X {ssh_cm, ssh_connection_ref(),
{closed, ssh_channel_id()}}

Indicates that the ssh channel started for the
execution of the command has now been shutdown.

These message should be handled by the
client. The ssh channel
behavior can be used when writing a client.

exit_status(ConnectionRef, ChannelId, Status) -> ok

ConnectionRef = ssh_connection_ref()

ChannelId = ssh_channel_id()

Status = integer()

Sends the exit status of a command to the client.

reply_request(ConnectionRef, WantReply, Status, CannelId) -> ok

ConnectionRef = ssh_connection_ref()

WantReply = boolean()

Status = ssh_request_status()

ChannelId = ssh_channel_id()

Sends status replies to requests where the requester has
stated that they want a status report e.i . WantReply = true,
if WantReply is false calling this function will be a
"noop". Should be called after handling an ssh connection
protocol message containing a WantReply boolean
value. See the ssh_channel behavior callback handle_ssh_msg/2