jnx_routing_base_service.proto

Service

Base

Provides base infra operations add, delete and get for route purge timer.

Method Name Request Type Response Type Description
RoutePurgeTimerAdd RoutePurgeTimerAddRequest RoutePurgeTimerAddResponse Configure purge timer for the client.
RoutePurgeTimerDelete RoutePurgeTimerDeleteRequest RoutePurgeTimerDeleteResponse Delete the purge timer for the client.
RoutePurgeTimerGet RoutePurgeTimerGetRequest RoutePurgeTimerGetResponse Retrieve the purge timer for the client.

RPC(s)

The following APIs are provided by this service:

RoutePurgeTimerAdd

Configure a purge timer for the client so that server side will retain the client installed routes till this time after client disconnects and provide sufficient time for the client to reconnect if possible. The default purge timer is 120 seconds. The valid purge timer range is between 1 and 1000 seconds.

Input: RoutePurgeTimerAddRequest

Output: RoutePurgeTimerAddResponse

RoutePurgeTimerDelete

Delete a previously configured purge timer for the client.

Input: RoutePurgeTimerDeleteRequest

Output: RoutePurgeTimerDeleteResponse

RoutePurgeTimerGet

Retrieve the purge timer for the client.

Input: RoutePurgeTimerGetRequest

Output: RoutePurgeTimerGetResponse

Message(s)

This IDL defines the following message type(s)

RoutePurgeTimerAddRequest

Route purge timer add request message to set purge timer for the client.

Field Type Description
time uint32 Purge time to be configured for the client.

RoutePurgeTimerAddResponse

Response message for the purget timer add request.

Field Type Description
status RpcStatus Purge Timer add response status.
sub_code StatusCode Purge Timer add response sub_code.

RoutePurgeTimerDeleteRequest

Route purge timer delete request message to delete. purge timer for the client.

Field Type Description

RoutePurgeTimerDeleteResponse

Route purge timer delete response message.

Field Type Description
status RpcStatus Purge Timer delete response status.
sub_code StatusCode Purge Timer delete response sub_code.

RoutePurgeTimerGetRequest

Route purge timer get request message.

Field Type Description

RoutePurgeTimerGetResponse

Route purge timer get response message to get purge timer for the client.

Field Type Description
status RpcStatus Purge Timer get response status.
sub_code StatusCode Purge Timer get response sub_code.
time uint32 Purge time in seconds configured for the client.

Enum(s)

StatusCode

response status code used by sub-code.

Value Description
SUCCESS Success.
INVALID_PARAMS Invalid parameters.