Zephyr Project API 4.4.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
client.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2024 Grant Ramsay <grant.ramsay@hotmail.com>
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
7#ifndef ZEPHYR_INCLUDE_NET_SSH_CLIENT_H_
8#define ZEPHYR_INCLUDE_NET_SSH_CLIENT_H_
9
21
22#include <zephyr/kernel.h>
23#include <zephyr/net/socket.h>
25
26#ifdef __cplusplus
27extern "C" {
28#endif
29
31
32struct ssh_client;
33
34struct ssh_client *ssh_client_instance(int instance);
35
37
50int ssh_client_start(struct ssh_client *ssh,
51 const char *user_name,
52 const struct net_sockaddr *addr,
53 int host_key_index,
55 void *user_data);
56
64int ssh_client_stop(struct ssh_client *ssh);
65
87
97
111struct ssh_client *ssh_transport_get_client(struct ssh_transport *transport);
112
113#ifdef __cplusplus
114}
115#endif
116
120
121#endif /* ZEPHYR_INCLUDE_NET_SSH_CLIENT_H_ */
int ssh_client_start(struct ssh_client *ssh, const char *user_name, const struct net_sockaddr *addr, int host_key_index, ssh_transport_event_callback_t callback, void *user_data)
Start an SSH client connection.
int ssh_client_stop(struct ssh_client *ssh)
Stop an SSH client connection.
int ssh_client_register_transport_callback(struct ssh_transport_conf *conf)
Register a callback function for getting the transport associated with a server connection.
int ssh_client_unregister_transport_callback(struct ssh_transport_conf *conf)
Unregister a callback function for getting the transport associated with a server connection.
struct ssh_client * ssh_transport_get_client(struct ssh_transport *transport)
Get the SSH client instance that owns a given transport.
int(* ssh_transport_event_callback_t)(struct ssh_transport *transport, const struct ssh_transport_event *event, void *user_data)
SSH transport event callback.
Definition common.h:187
SSH client/server common API.
Public kernel APIs.
BSD Sockets compatible API definitions.
Generic sockaddr struct.
Definition net_ip.h:455
SSH transport callback configuration.
Definition common.h:192