SRP

Esta enumeración especifica el estado de un elemento de cliente de SRP (información de servicio o de host).

Esta enumeración representa el modo de dirección utilizado por el servidor SRP.

El modo de dirección especifica cómo el servidor SRP determina la dirección y el número de puerto y cómo se publica esta información en Thread Network Data.

Representa el estado de un servidor SRP.

Este tipo de puntero de función define la devolución de llamada utilizada por el cliente SRP para notificar al usuario cuando se inicia o se detiene automáticamente.

Esto sólo se utiliza cuando la función de inicio automático OPENTHREAD_CONFIG_SRP_CLIENT_AUTO_START_API_ENABLE está activado.

Esta devolución de llamada se invoca cuando el modo de inicio automático está habilitado y el cliente SRP se inicia o detiene automáticamente.

Esta estructura representa una entrada de grupo de servicios de cliente de SRP.

Este tipo de puntero de función define la devolución de llamada utilizada por el cliente SRP para notificar al usuario de cambios / eventos / errores.

Esta devolución de llamada se invoca en un registro exitoso de una actualización (es decir, agregar / eliminar información de host y / o algunos servicios) con el servidor SRP, o si hay una falla o error (por ejemplo, el servidor rechaza una actualización la solicitud o el cliente agota el tiempo de espera de respuesta, etc.).

En caso de un nuevo registro con éxito de una actualización, aError parámetro sería OT_ERROR_NONE y la información de host y la lista completa de los servicios se proporcionan como parámetros de entrada a la devolución de llamada. Nótese que información y servicios anfitrión cada pista su propio estado en el correspondiente mState variable miembro de la estructura de datos relacionado (el estado que indica si el host-info / servicio se ha registrado o retirado o todavía ser añadido / eliminado, etc).

La lista de servicios retirados se pasa como sus propios lista enlazada aRemovedServices en la devolución de llamada. Tenga en cuenta que cuando se invoca la devolución de llamada, el cliente de SRP (aplicación OpenThread) se realiza con los casos extraídos de servicios que figuran en aRemovedServices y no hay pistas más largas / tiendas de ellos (es decir, si es de la devolución de llamada que llamamos otSrpClientGetServices() los servicios eliminados no será presente en la lista devuelta). Proporcionar una lista separada de servicios eliminados en la devolución de llamada ayuda a indicar al usuario qué elementos se eliminan ahora y permite al usuario volver a reclamar / reutilizar las instancias.

Si el servidor rechaza una solicitud de actualización de SRP, el código de respuesta de DNS (RFC 2136) se asigna a los siguientes errores:

• (0) NOERROR Correcto (sin condición de error) -> OT_ERROR_NONE
• (1) El servidor FORMERR no puede interpretar debido a un error de formato -> OT_ERROR_PARSE
• (2) El servidor SERVFAIL encontró una falla interna -> OT_ERROR_FAILED
• (3) NXDOMAIN Nombre que debería existir, no existe -> OT_ERROR_NOT_FOUND
• (4) El servidor NOTIMP no admite el tipo de consulta (OpCode) -> OT_ERROR_NOT_IMPLEMENTED
• (5) RECHAZADO Servidor rechazado por motivos de política / seguridad -> OT_ERROR_SECURITY
• (6) YXDOMAIN Algún nombre que no debería existir, existe -> OT_ERROR_DUPLICATED
• (7) YXRRSET Algún RRset que no debería existir, existe -> OT_ERROR_DUPLICATED
• (8) NXRRSET Algún RRset que debería existir, no existe -> OT_ERROR_NOT_FOUND
• (9) NOTAUTH El servicio no está autorizado para la zona -> OT_ERROR_SECURITY
• (10) NOTZONE Un nombre no está en la zona -> OT_ERROR_PARSE
• (20) BADNAME Mal nombre -> OT_ERROR_PARSE
• (21) BADALG Mal algoritmo -> OT_ERROR_SECURITY
• (22) BADTRUN Truncamiento incorrecto -> OT_ERROR_PARSE
• Otros códigos de respuesta -> OT_ERROR_FAILED

También son posibles los siguientes errores:

• OT_ERROR_RESPONSE_TIMEOUT: Se agotó el tiempo de espera para la respuesta del servidor (el cliente continuaría reintentando).
• OT_ERROR_INVALID_ARGS: La estructura de servicio proporcionado no es válido (por ejemplo, el nombre del servicio o mala otDnsTxtEntry ).
• OT_ERROR_NO_BUFS: Búfer insuficiente para preparar o enviar el mensaje de actualización.

Tenga en cuenta que en caso de cualquier falla, el cliente continúa la operación, es decir, prepara y (re) transmite el mensaje de actualización de SRP al servidor, después de un intervalo de espera. El reintento esperar aperturas intervalo desde el valor mínimo y se incrementa por el factor de crecimiento de cada fracaso hasta el valor máximo (por favor ver la configuración de parámetros OPENTHREAD_CONFIG_SRP_CLIENT_MIN_RETRY_WAIT_INTERVAL y los relacionados para más detalles).

Esta estructura representa la información del host del cliente SRP.

Esta estructura representa un servicio de cliente SRP.

Los valores de esta estructura, incluyendo las memorias intermedias de cadena para los nombres y las entradas de registro TXT, deben persistir y estancia constante después de una instancia de esta estructura se pasa a OpenThread de otSrpClientAddService() o otSrpClientRemoveService() .

Esta enumeración representa el modo de dirección utilizado por el servidor SRP.

El modo de dirección especifica cómo el servidor SRP determina la dirección y el número de puerto y cómo se publica esta información en Thread Network Data.

Este tipo opaco representa un host de servicio SRP.

Esta estructura incluye configuraciones de ARRENDAMIENTO y ARRENDAMIENTO DE LLAVE del servidor SRP.

Este tipo opaco representa un servicio SRP.

El tipo de indicador de servicio para indicar qué servicios incluir o excluir al buscar (o iterar) en la lista de servicios SRP.

Esta es una combinación de indicadores de bits. Los bits indicadores específicos se definen en la enumeración OT_SRP_SERVER_FLAG_* .

Esta función maneja las actualizaciones del servicio SRP.

El servidor SRP llama a esta función para notificar que se están actualizando un host SRP y posiblemente los servicios SRP. Es importante que las actualizaciones de SRP no están comprometidos hasta que el controlador devuelve el resultado llamando otSrpServerHandleServiceUpdateResult o el tiempo de espera después de aTimeout .

Un observador del servicio SRP siempre debe llamar a otSrpServerHandleServiceUpdateResult con el código de error OT_ERROR_NONE inmediatamente después de recibir los eventos de actualización.

Un manejador más genérico puede realizar validaciones en el host / servicios de SRP y rechazar las actualizaciones de SRP si falla alguna validación. Por ejemplo, un proxy de publicidad debe anunciar (o eliminar) el host y los servicios en un enlace con capacidad de multidifusión y devolver un código de error específico si se produce alguna falla.

El ID de una transacción de actualización del servicio SRP en el servidor SRP.

Esta función agrega un servicio para ser registrado con el servidor.

Después de una llamada exitosa a esta función, otSrpClientCallback será llamado para reportar el estado de la adición de servicios / registro con el servidor SRP.

El otSrpClientService instancia que se está apuntado por aService deben persistir y permanecer sin cambios después de regresar de esta función (con OT_ERROR_NONE ). OpenThread guardará el puntero a la instancia del servicio.

El otSrpClientService instancia no está ya rastreado por OpenThread y se puede recuperar sólo cuando

• Se elimina explícitamente por una llamada a otSrpClientRemoveService() o se elimina junto con otros servicios por una llamada a otSrpClientRemoveHostAndServices() and only after the otSrpClientCallback` se llama que indica el servicio se eliminó. O,
• Una llamada a otSrpClientClearHostAndServices() que elimina el anfitrión y todos los servicios relacionados inmediatamente.

Esta función asigna una nueva entrada de servicio del grupo.

La instancia de entrada de servicio devuelta se inicializará de la siguiente manera:

• mService.mName apuntará a un búfer de cadena asignado que puede ser recuperada utilizando la función de otSrpClientBuffersGetServiceEntryServiceNameString() .
• mService.mInstanceName apuntará a un búfer de cadena asignado que puede ser recuperada utilizando la función de otSrpClientBuffersGetServiceEntryInstanceNameString() .
• mService.mSubTypeLabels apunta a un array que se devuelve desde otSrpClientBuffersGetSubTypeLabelsArray() .
• mService.mTxtEntries apuntarán a mTxtEntry .
• mService.mNumTxtEntries se ajustarán a uno.
• Otros mService campos (puerto, prioridad, peso) se ponen a cero.
• mTxtEntry.mKey se establece en NULL (valor se trata como ya se ha codificado).
• mTxtEntry.mValue apuntará a un búfer asignado que puede ser recuperada utilizando la función de otSrpClientBuffersGetServiceEntryTxtBuffer() .
• mTxtEntry.mValueLength se establece en cero.
• Todos los búferes y matrices de datos / cadenas relacionados se borran a cero.

Esta función libera todas las entradas de servicio asignadas previamente.

Esta función libera una entrada de servicio previamente asignada.

El aService deben asignarse previamente usando otSrpClientBuffersAllocateService() y aún no liberado. De lo contrario, el comportamiento de esta función no está definido.

Esta función obtiene la matriz de entradas de direcciones IPv6 para usar como lista de direcciones de host del cliente SRP.

Esta función obtiene el búfer de cadena que se utilizará para el nombre de host del cliente SRP.

Esta función obtiene el búfer de cadena para el nombre de la instancia de servicio de una entrada de servicio.

Esta función obtiene el búfer de cadena para el nombre del servicio de una entrada de servicio.

Esta función obtiene el búfer para el registro TXT de una entrada de servicio.

Esta función obtiene la matriz de etiquetas de subtipo de servicio de la entrada de servicio.

Esta función borra toda la información del host y todos los servicios.

A diferencia de otSrpClientRemoveHostAndServices() que envía un mensaje de actualización al servidor para eliminar toda la información, esta función borra toda la información de inmediato sin ningún tipo de interacción con el servidor.

Esta función borra un servicio, eliminándolo inmediatamente de la lista de servicios del cliente.

A diferencia de otSrpClientRemoveService() que envía un mensaje de actualización al servidor para quitar el servicio, esta función borra el servicio de lista de servicio del cliente sin ningún tipo de interacción con el servidor. En una llamada con éxito a esta función, el otSrpClientCallback no será llamado y el aService entrada puede ser recuperado y reutilizado por el llamador inmediato.

Esta función se puede utilizar junto con una llamada posterior a otSrpClientAddService() (potencialmente la reutilización de la misma aService entrada con el mismo servicio y nombres de instancia) para actualizar algunos de los parámetros en un servicio existente.

Esta función desactiva el modo de inicio automático.

Esto sólo está disponible cuando la función de inicio automático OPENTHREAD_CONFIG_SRP_CLIENT_AUTO_START_API_ENABLE está activado.

La desactivación del modo de inicio automático no detendrá al cliente si ya se está ejecutando, pero el cliente deja de monitorear los datos de la red de subprocesos para verificar que el servidor SRP seleccionado todavía está presente en él.

Tenga en cuenta que una llamada a otSrpClientStop() también desactivará el modo de inicio automático.

Esta función habilita el modo de inicio automático.

Esto sólo está disponible cuando la función de inicio automático OPENTHREAD_CONFIG_SRP_CLIENT_AUTO_START_API_ENABLE está activado.

Config opción OPENTHREAD_CONFIG_SRP_CLIENT_AUTO_START_DEFAULT_MODE especifica el modo de auto-arranque por defecto (si está activado o desactivado en el inicio de pila OT).

Cuando el inicio automático está habilitado, el cliente SRP monitoreará los datos de la red de subprocesos para las entradas del servicio del servidor SRP e iniciará y detendrá automáticamente el cliente cuando se detecte un servidor SRP.

Si se encuentran varios servidores SRP, se seleccionará uno al azar. Si el servidor SRP seleccionado ya no se detecta (ya no está presente en Thread Network Data), el cliente SRP se detendrá y luego puede cambiar a otro servidor SRP (si está disponible).

Cuando el cliente de SRP se inicia de forma explícita a través de una llamada exitosa a otSrpClientStart() , la dirección del servidor SRP dada en otSrpClientStart() va a seguir utilizándose sin importar el estado del modo de inicio automático y si la misma dirección del servidor SRP se descubre o no en los datos de la red de subprocesos. En este caso, sólo una explícita otSrpClientStop() llamada se detendrá el cliente.

Esta función obtiene el nombre de dominio que utiliza el cliente SRP.

Esta función requiere OPENTHREAD_CONFIG_SRP_CLIENT_DOMAIN_NAME_API_ENABLE esté habilitado.

Si no se establece el nombre de dominio, se utilizará "default.service.arpa".

Esta función obtiene la información del host.

Esta función obtiene el intervalo de concesión de claves que se utiliza en las solicitudes de actualización de SRP.

Tenga en cuenta que esta es la duración de la concesión solicitada por el cliente de SRP. El servidor puede optar por aceptar un intervalo de arrendamiento diferente.

Esta función obtiene el intervalo de concesión utilizado en las solicitudes de actualización de SRP.

Tenga en cuenta que esta es la duración de la concesión solicitada por el cliente de SRP. El servidor puede optar por aceptar un intervalo de arrendamiento diferente.

Esta función obtiene la dirección de socket (dirección IPv6 y número de puerto) del servidor SRP que está siendo utilizado por el cliente SRP.

Si el cliente no se está ejecutando, la dirección no se especifica (todo cero) con un número de puerto cero.

Esta función obtiene la lista de servicios gestionados por el cliente.

Esta función indica el estado actual del modo de inicio automático (habilitado o deshabilitado).

Esto sólo está disponible cuando la función de inicio automático OPENTHREAD_CONFIG_SRP_CLIENT_AUTO_START_API_ENABLE está activado.

Esta función indica si el cliente SRP se está ejecutando o no.

Este método indica si el modo "inclusión de registro de clave de servicio" está habilitado o deshabilitado.

Esta función está disponible cuando OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE se habilita la configuración.

Esta función convierte un otSrpClientItemState en una cadena.

Esta función inicia el proceso de eliminación de la información del host y todos los servicios.

Después de regresar de esta función, otSrpClientCallback será llamado para informar del estado de la solicitud de eliminación con el servidor SRP.

Si la información de host debe ser eliminado de forma permanente desde el servidor, aRemoveKeyLease debe establecerse en true que elimina el contrato de arrendamiento clave asociada con el anfitrión en el servidor. De lo contrario, el registro de arrendamiento de claves se mantiene como antes, lo que garantiza que el servidor mantenga el nombre de host en reserva para cuando el cliente pueda volver a proporcionar y registrar su (s) servicio (s).

El aSendUnregToServer determina el comportamiento cuando la información de host aún no se ha registrado en el servidor. Si aSendUnregToServer se establece en false (que es el / valor esperado por defecto), entonces el cliente de SRP retirará de inmediato el información y servicios de host sin necesidad de enviar un mensaje de actualización al servidor (no hay necesidad de actualizar el servidor si aún no hay nada registrado en él). Si aSendUnregToServer se establece en true entonces el cliente de SRP enviará un mensaje de actualización al servidor. Tenga en cuenta que si la información de host se registra entonces el valor de aSendUnregToServer no importa y el cliente de SRP siempre enviará un mensaje de actualización al servidor que solicita la eliminación de toda la información.

Una situación en la que aSendUnregToServer puede ser útil es en el reinicio del aparato / reinicio, la persona que llama lo desea, puede eliminar cualquiera de los servicios previamente registrados en el servidor. En este caso, la persona que llama puede otSrpClientSetHostName() y luego solicitar otSrpClientRemoveHostAndServices() con aSendUnregToServer como true .

Esta función solicita que se anule el registro de un servicio con el servidor.

Después de una llamada exitosa a esta función, otSrpClientCallback será llamado para informar del estado de la solicitud de eliminación con el servidor SRP.

El otSrpClientService instancia que se está apuntado por aService deben persistir y permanecer sin cambios después de regresar de esta función (con OT_ERROR_NONE ). OpenThread mantendrá la instancia del servicio durante el proceso de eliminación. Sólo después de la otSrpClientCallback se llama lo que indica la instancia de servicio se elimina de la lista de servicio al cliente de SRP y pueden ser liberados / reutilizada.

Esta función establece la devolución de llamada para notificar a la persona que llama sobre eventos / cambios del cliente SRP.

El cliente SRP permite registrar una única devolución de llamada. Por lo tanto, las llamadas consecutivas a esta función sobrescribirán cualquier función de devolución de llamada configurada previamente.

Esta función establece el nombre de dominio que utilizará el cliente SRP.

Esta función requiere OPENTHREAD_CONFIG_SRP_CLIENT_DOMAIN_NAME_API_ENABLE esté habilitado.

Si no se establece, se utilizará "default.service.arpa".

El búfer de nombres de cadena apuntada por aName deben persistir y permanecer sin cambios después de regresar de esta función. OpenThread mantendrá el puntero a la cadena.

El nombre de dominio se puede configurar antes de que se inicie el cliente o después de la salida, pero antes de información de hospedaje se ha registrado en el servidor (información de host debe estar en cualquiera STATE_TO_ADD o STATE_TO_REMOVE ).

Esta función establece / actualiza la lista de direcciones IPv6 del host.

Las direcciones IPv6 del host se pueden configurar / cambiar antes del inicio o durante la operación del cliente SRP (por ejemplo, para agregar / eliminar o cambiar una dirección de host registrada previamente), excepto cuando se está eliminando la información del host (el cliente está ocupado manejando una solicitud de eliminación de una llamada a otSrpClientRemoveHostAndServices() y la información de host sigue siendo en cualquier STATE_TO_REMOVE o STATE_REMOVING Unidos).

El IPv6 array dirección de host apuntado por aAddresses deben persistir y permanecer sin cambios después de regresar de esta función (con OT_ERROR_NONE ). OpenThread guardará el puntero en la matriz.

Después de una llamada exitosa a esta función, otSrpClientCallback será llamado para reportar el estado del registro de direcciones con el servidor SRP.

This function sets the host name label.

After a successful call to this function, otSrpClientCallback will be called to report the status of host info registration with SRP server.

The name string buffer pointed to by aName MUST persist and stay unchanged after returning from this function. OpenThread will keep the pointer to the string.

The host name can be set before client is started or after start but before host info is registered with server (host info should be in either STATE_TO_ADD or STATE_REMOVED ).

This function sets the key lease interval used in SRP update requests.

Changing the lease interval does not impact the accepted lease interval of already registered services/host-info. It only affects any future SRP update messages (ie, adding new services and/or refreshes of existing services).

This function sets the lease interval used in SRP update requests.

Changing the lease interval does not impact the accepted lease interval of already registered services/host-info. It only affects any future SRP update messages (ie, adding new services and/or refreshes of the existing services).

This function enables/disables "service key record inclusion" mode.

When enabled, SRP client will include KEY record in Service Description Instructions in the SRP update messages that it sends.

This function is available when OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE configuration is enabled.

This function starts the SRP client operation.

SRP client will prepare and send "SRP Update" message to the SRP server once all the following conditions are met:

• The SRP client is started - otSrpClientStart() is called.
• Host name is set - otSrpClientSetHostName() is called.
• At least one host IPv6 address is set - otSrpClientSetHostName() is called.
• At least one service is added - otSrpClientAddService() is called.

It does not matter in which order these functions are called. When all conditions are met, the SRP client will wait for a short delay before preparing an "SRP Update" message and sending it to server. This delay allows for user to add multiple services and/or IPv6 addresses before the first SRP Update message is sent (ensuring a single SRP Update is sent containing all the info). The config OPENTHREAD_CONFIG_SRP_CLIENT_UPDATE_TX_DELAY specifies the delay interval.

This function stops the SRP client operation.

This function stops any further interactions with the SRP server. Note that it does not remove or clear host info and/or list of services. It marks all services to be added/removed again once the client is (re)started.

This function returns the address mode being used by the SRP server.

This function returns the sequence number used with anycast address mode.

The sequence number is included in "DNS/SRP Service Anycast Address" entry published in the Network Data.

This function returns the domain authorized to the SRP server.

If the domain if not set by SetDomain, "default.service.arpa." will be returned. A trailing dot is always appended even if the domain is set without it.

This function returns SRP server LEASE and KEY-LEASE configurations.

This function returns the next registered host on the SRP server.

This function returns the state of the SRP server.

This function reports the result of processing a SRP update to the SRP server.

The Service Update Handler should call this function to return the result of its processing of a SRP update.

This function finds the next matching service on the host.

The combination of flags and service and instance names enables iterating over the full list of services and/or a subset of them matching certain conditions, or finding a specific service.

To iterate over all services of a host: service = otSrpServerHostFindNextService(host, service, OT_SRP_SERVER_FLAGS_ANY_SERVICE, NULL, NULL);

To iterate over base services only (exclude sub-types): service = otSrpServerHostFindNextService(host, service, OT_SRP_SERVER_FLAGS_BASE_TYPE_SERVICE_ONLY, NULL, NULL);

To iterate over sub-types of a specific instance name instanceName : service = otSrpServerHostFindNextService(host, service, OT_SRP_SERVER_FLAGS_SUB_TYPE_SERVICE_ONLY, NULL, instanceName);

To find a specific service with service name serviceName and service instance name instanceName : service = otSrpServerHostFindNextService(host, NULL, OT_SRP_SERVER_FLAGS_ANY_SERVICE, serviceName, instanceName);

To find the base type service with a given service instance name instanceName : service = otSrpServerHostFindNextService(host, NULL, OT_SRP_SERVER_FLAGS_BASE_TYPE_SERVICE_ONLY, NULL, instanceName);

This function returns the addresses of given host.

This function returns the full name of the host.

This function returns the next service (excluding any sub-type services) of given host.

This function tells if the SRP service host has been deleted.

A SRP service host can be deleted but retains its name for future uses. In this case, the host instance is not removed from the SRP server/registry.

This function returns the full service instance name of the service.

This function returns the host which the service instance reside on.

This function returns the full service instance name of the service.

This function returns the port of the service instance.

This function returns the priority of the service instance.

This function returns the full service name of the service.

This function gets the sub-type label from service name.

This function is intended to be used when the aService is a sub-type, ie, otSrpServerServiceIsSubType() for the service returns TRUE. If it is not a sub-type this function returns OT_ERROR_INVALID_ARGS .

The full service name for a sub-type service follows " ._sub. . .". This function copies the into the aLabel buffer.

The aLabel is ensured to always be null-terminated after returning even in case of failure.

This function returns the TXT record data of the service instance.

This function returns the weight of the service instance.

This function indicates whether or not the SRP service has been deleted.

A SRP service can be deleted but retains its name for future uses. In this case, the service instance is not removed from the SRP server/registry. It is guaranteed that all services are deleted if the host is deleted.

This function indicates whether or not the SRP service is sub-type.

This function sets the address mode to be used by the SRP server.

This function sets the sequence number used with anycast address mode.

This function sets the domain on the SRP server.

A trailing dot will be appended to aDomain if it is not already there. This function should only be called before the SRP server is enabled.

This function enables/disables the SRP server.

This function sets SRP server LEASE and KEY-LEASE configurations.

When a non-zero LEASE time is requested from a client, the granted value will be limited in range [aMinLease, aMaxLease]; and a non-zero KEY-LEASE will be granted in range [aMinKeyLease, aMaxKeyLease]. For zero LEASE or KEY-LEASE time, zero will be granted.

This function sets the SRP service updates handler on SRP server.