SshClientNotify¶

[Source]

Client-side consumer interface. The session calls these as the connection progresses: it must approve or reject the server host key (ssh_verify_host_key → session.accept_host_key/reject_host_key), is told when the session is ready and authenticated (ssh_ready), and receives channel and error events. Every callback receives the session tag so the consumer can drive it.

interface ref SshClientNotify

Public Behaviours¶

ssh_verify_host_key¶

[Source]

be ssh_verify_host_key(
  session: SshSession tag,
  host: String val,
  key: SshHostKey val)

Parameters¶

session: SshSession tag
host: String val
key: SshHostKey val

ssh_ready¶

[Source]

be ssh_ready(
  session: SshSession tag)

Parameters¶

session: SshSession tag

ssh_auth_failed¶

[Source]

be ssh_auth_failed(
  session: SshSession tag,
  err: SshAuthError val)

Parameters¶

session: SshSession tag
err: SshAuthError val

ssh_channel_opened¶

[Source]

be ssh_channel_opened(
  session: SshSession tag,
  channel_id: U32 val)

Parameters¶

session: SshSession tag
channel_id: U32 val

ssh_channel_request_result¶

[Source]

Reports a peer reply to a channel request sent with want_reply set. The reply contains no request identifier. Wait for a result before sending another reply-seeking request on the same channel if its identity matters.

be ssh_channel_request_result(
  session: SshSession tag,
  channel_id: U32 val,
  accepted: Bool val)

Parameters¶

session: SshSession tag
channel_id: U32 val
accepted: Bool val

ssh_channel_data¶

[Source]

be ssh_channel_data(
  session: SshSession tag,
  channel_id: U32 val,
  data: Array[U8 val] val)

Parameters¶

session: SshSession tag
channel_id: U32 val
data: Array[U8 val] val

ssh_channel_error¶

[Source]

be ssh_channel_error(
  session: SshSession tag,
  channel_id: U32 val,
  err: SshChannelError val)

Parameters¶

session: SshSession tag
channel_id: U32 val
err: SshChannelError val

ssh_channel_send_result¶

[Source]

Reports one result for each channel_send call. accepted counts the prefix admitted locally. data is the original submitted array. A blocked suffix remains the caller's responsibility.

be ssh_channel_send_result(
  session: SshSession tag,
  channel_id: U32 val,
  data: Array[U8 val] val,
  accepted: USize val,
  outcome: SshSendOutcome)

Parameters¶

session: SshSession tag
channel_id: U32 val
data: Array[U8 val] val
accepted: USize val
outcome: SshSendOutcome

ssh_channel_window_available¶

[Source]

The peer granted credit after a blocked send. The hint is sent once until another send blocks; it does not reserve credit for a retry.

be ssh_channel_window_available(
  session: SshSession tag,
  channel_id: U32 val)

Parameters¶

session: SshSession tag
channel_id: U32 val

ssh_channel_closed¶

[Source]

be ssh_channel_closed(
  session: SshSession tag,
  channel_id: U32 val)

Parameters¶

session: SshSession tag
channel_id: U32 val

ssh_error¶

[Source]

be ssh_error(
  session: SshSession tag,
  err: SshTransportError val)

Parameters¶

session: SshSession tag
err: SshTransportError val

ssh_disconnected¶

[Source]

be ssh_disconnected(
  session: SshSession tag)

Parameters¶

session: SshSession tag