assh/helper_io.h header reference
Description
This header provides helper functions designed to handle events generated by the transport layer.
It also provides terminal related helper functions.
Header inclusion
Members
Functions
- size_t asshh_fd_event(assh_session_s *s, assh_event_s *e, int fd)
- assh_status_t asshh_fd_get_password(assh_context_s *c, const char **pass, size_t max_len, int fd, assh_bool_t echo)
- void asshh_print_kex_details(assh_session_s *s, FILE *out, const assh_event_s *event)
- void asshh_print_string(FILE *out, const assh_cbuffer_s *str)
Members detail
size_t asshh_fd_event(assh_session_s *s, assh_event_s *e, int fd)
This function is declared in assh/helper_io.h source file, line 49.
This function can be used to handle the ASSH_EVENT_READ and ASSH_EVENT_WRITE events by reading from and writing to a file descriptor. The amount of transferred data is returned.
This function takes care of calling the assh_event_done function.
assh_status_t asshh_fd_get_password(assh_context_s *c, const char **pass, size_t max_len, int fd, assh_bool_t echo)
This function is declared in assh/helper_io.h source file, line 57.
This function read characters on the file descriptor until a new line is found. The terminal echo is disabled. Characters beyond the specified length are read but ignored. This function fails if the file descriptor is not a tty.
void asshh_print_kex_details(assh_session_s *s, FILE *out, const assh_event_s *event)
This function is declared in assh/helper_io.h source file, line 67.
This function prints a list of algorithms selected by the kex exchange.
void asshh_print_string(FILE *out, const assh_cbuffer_s *str)
This function is declared in assh/helper_io.h source file, line 62.
This function writes a string to the passed stream, filtering out terminal control characters.