assh/assh_service.h header reference
Description
This header file provides declarations related to the service module interface. Functions are provided to register services on a library assh_context_s object.
See also Core and modules and SSH services.
Members
Types
- struct assh_event_service_start_s
- union assh_event_service_u
- struct assh_service_s
Functions
- assh_status_t assh_service_by_name(assh_context_s *c, size_t name_len, const char *name, const assh_service_s **srv_)
- assh_status_t assh_service_register(assh_context_s *c, assh_service_s *srv)
- assh_status_t assh_service_register_default(assh_context_s *c)
- assh_status_t assh_service_register_va(assh_context_s *c, ...)
Members detail
This struct is declared in assh/assh_service.h source file, line 132.
The ASSH_EVENT_SERVICE_START event is reported when a service has started.
Field | Description |
---|---|
const assh_service_s *const srv; | A pointer to the module descriptor of the starting service. (ro) |
This union is declared in assh/assh_service.h source file, line 139.
This union contains all service related event structures.
Field | Description |
---|---|
assh_event_service_start_s start; |
assh_status_t assh_service_by_name(assh_context_s *c, size_t name_len, const char *name, const assh_service_s **srv_)
This function is declared in assh/assh_service.h source file, line 174.
This function lookup a registered service by name.
assh_status_t assh_service_register(assh_context_s *c, assh_service_s *srv)
This function is declared in assh/assh_service.h source file, line 147.
This function registers a single assh_service_s for use by the given context.
See also assh_service_register_va.
assh_status_t assh_service_register_default(assh_context_s *c)
This function is declared in assh/assh_service.h source file, line 162.
This function registers the standard ssh-userauth and ssh-connection services. The appropriate client or server services are used depending on the context type.
assh_status_t assh_service_register_va(assh_context_s *c, ...)
This function is declared in assh/assh_service.h source file, line 156.
This function registers one or more assh_service_s for use by the given context.
When registering service modules onto a client context, the registration order determines the order used to request execution of the services.
See also assh_service_register.
This struct is declared in assh/assh_service.h source file, line 118.
This struct is the service module descriptor. It can be registered on a assh_context_s instance for use by all associated sessions.
See also Core and modules and assh_service_register.