SSH client/server common API

Typedefs
typedef void(*	ssh_service_client_cb_t) (struct ssh_client *ssh, int instance, void *user_data)
	Callback used while iterating over SSH client connections.
typedef void(*	ssh_service_server_cb_t) (struct ssh_server *sshd, int instance, void *user_data)
	Callback used while iterating over SSH server connections.

Functions
void	ssh_client_foreach (ssh_service_client_cb_t cb, void *user_data)
	Go through all SSH client connections.
void	ssh_server_foreach (ssh_service_server_cb_t cb, void *user_data)
	Go through all SSH server connections.

Detailed Description

Since

4.5

Version

0.1.0

Typedef Documentation

ssh_service_client_cb_t

typedef void(* ssh_service_client_cb_t) (struct ssh_client *ssh, int instance, void *user_data)

#include <zephyr/net/ssh/common.h>

Callback used while iterating over SSH client connections.

Parameters

ssh	Pointer to the SSH client instance
instance	SSH client instance id
user_data	A valid pointer to user data or NULL

ssh_service_server_cb_t

typedef void(* ssh_service_server_cb_t) (struct ssh_server *sshd, int instance, void *user_data)

#include <zephyr/net/ssh/common.h>

Callback used while iterating over SSH server connections.

Parameters

sshd	Pointer to the SSH server instance
instance	SSH server instance id
user_data	A valid pointer to user data or NULL

Function Documentation

ssh_client_foreach()

void ssh_client_foreach	(	ssh_service_client_cb_t	cb,
		void *	user_data )

#include <zephyr/net/ssh/common.h>

Go through all SSH client connections.

Parameters

cb	User-supplied callback function to call
user_data	User specified data

ssh_server_foreach()

void ssh_server_foreach	(	ssh_service_server_cb_t	cb,
		void *	user_data )

#include <zephyr/net/ssh/common.h>

Go through all SSH server connections.

Parameters

cb	User-supplied callback function to call
user_data	User specified data