Struct chirpstack_api::ns::network_server_service_client::NetworkServerServiceClient

pub struct NetworkServerServiceClient<T> { /* fields omitted */ }

NetworkServerService provides the network-server API methods.

Implementations

impl NetworkServerServiceClient<Channel>

pub async fn connect<D>(dst: D) -> Result<Self, Error> where
    D: TryInto<Endpoint>,
    D::Error: Into<StdError>, 

Attempt to create a new client by connecting to a given endpoint.

impl<T> NetworkServerServiceClient<T> where
    T: GrpcService<BoxBody>,
    T::ResponseBody: Body + HttpBody + Send + 'static,
    T::Error: Into<StdError>,
    <T::ResponseBody as HttpBody>::Error: Into<StdError> + Send, 

pub fn new(inner: T) -> Self

pub fn with_interceptor(inner: T, interceptor: impl Into<Interceptor>) -> Self

pub async fn create_service_profile(
    &mut self,
    request: impl IntoRequest<CreateServiceProfileRequest>
) -> Result<Response<CreateServiceProfileResponse>, Status>

CreateServiceProfile creates the given service-profile.

pub async fn get_service_profile(
    &mut self,
    request: impl IntoRequest<GetServiceProfileRequest>
) -> Result<Response<GetServiceProfileResponse>, Status>

GetServiceProfile returns the service-profile matching the given id.

pub async fn update_service_profile(
    &mut self,
    request: impl IntoRequest<UpdateServiceProfileRequest>
) -> Result<Response<()>, Status>

UpdateServiceProfile updates the given service-profile.

pub async fn delete_service_profile(
    &mut self,
    request: impl IntoRequest<DeleteServiceProfileRequest>
) -> Result<Response<()>, Status>

DeleteServiceProfile deletes the service-profile matching the given id.

pub async fn create_routing_profile(
    &mut self,
    request: impl IntoRequest<CreateRoutingProfileRequest>
) -> Result<Response<CreateRoutingProfileResponse>, Status>

CreateRoutingProfile creates the given routing-profile.

pub async fn get_routing_profile(
    &mut self,
    request: impl IntoRequest<GetRoutingProfileRequest>
) -> Result<Response<GetRoutingProfileResponse>, Status>

GetRoutingProfile returns the routing-profile matching the given id.

pub async fn update_routing_profile(
    &mut self,
    request: impl IntoRequest<UpdateRoutingProfileRequest>
) -> Result<Response<()>, Status>

UpdateRoutingProfile updates the given routing-profile.

pub async fn delete_routing_profile(
    &mut self,
    request: impl IntoRequest<DeleteRoutingProfileRequest>
) -> Result<Response<()>, Status>

DeleteRoutingProfile deletes the routing-profile matching the given id.

pub async fn create_device_profile(
    &mut self,
    request: impl IntoRequest<CreateDeviceProfileRequest>
) -> Result<Response<CreateDeviceProfileResponse>, Status>

CreateDeviceProfile creates the given device-profile.

pub async fn get_device_profile(
    &mut self,
    request: impl IntoRequest<GetDeviceProfileRequest>
) -> Result<Response<GetDeviceProfileResponse>, Status>

GetDeviceProfile returns the device-profile matching the given id.

pub async fn update_device_profile(
    &mut self,
    request: impl IntoRequest<UpdateDeviceProfileRequest>
) -> Result<Response<()>, Status>

UpdateDeviceProfile updates the given device-profile.

pub async fn delete_device_profile(
    &mut self,
    request: impl IntoRequest<DeleteDeviceProfileRequest>
) -> Result<Response<()>, Status>

DeleteDeviceProfile deletes the device-profile matching the given id.

pub async fn create_device(
    &mut self,
    request: impl IntoRequest<CreateDeviceRequest>
) -> Result<Response<()>, Status>

CreateDevice creates the given device.

pub async fn get_device(
    &mut self,
    request: impl IntoRequest<GetDeviceRequest>
) -> Result<Response<GetDeviceResponse>, Status>

GetDevice returns the device matching the given DevEUI.

pub async fn update_device(
    &mut self,
    request: impl IntoRequest<UpdateDeviceRequest>
) -> Result<Response<()>, Status>

UpdateDevice updates the given device.

pub async fn delete_device(
    &mut self,
    request: impl IntoRequest<DeleteDeviceRequest>
) -> Result<Response<()>, Status>

DeleteDevice deletes the device matching the given DevEUI.

pub async fn activate_device(
    &mut self,
    request: impl IntoRequest<ActivateDeviceRequest>
) -> Result<Response<()>, Status>

ActivateDevice activates a device (ABP).

pub async fn deactivate_device(
    &mut self,
    request: impl IntoRequest<DeactivateDeviceRequest>
) -> Result<Response<()>, Status>

DeactivateDevice de-activates a device.

pub async fn get_device_activation(
    &mut self,
    request: impl IntoRequest<GetDeviceActivationRequest>
) -> Result<Response<GetDeviceActivationResponse>, Status>

GetDeviceActivation returns the device activation details.

pub async fn create_device_queue_item(
    &mut self,
    request: impl IntoRequest<CreateDeviceQueueItemRequest>
) -> Result<Response<()>, Status>

CreateDeviceQueueItem creates the given device-queue item.

pub async fn flush_device_queue_for_dev_eui(
    &mut self,
    request: impl IntoRequest<FlushDeviceQueueForDevEuiRequest>
) -> Result<Response<()>, Status>

FlushDeviceQueueForDevEUI flushes the device-queue for the given DevEUI.

pub async fn get_device_queue_items_for_dev_eui(
    &mut self,
    request: impl IntoRequest<GetDeviceQueueItemsForDevEuiRequest>
) -> Result<Response<GetDeviceQueueItemsForDevEuiResponse>, Status>

GetDeviceQueueItemsForDevEUI returns all device-queue items for the given DevEUI.

pub async fn get_next_downlink_f_cnt_for_dev_eui(
    &mut self,
    request: impl IntoRequest<GetNextDownlinkFCntForDevEuiRequest>
) -> Result<Response<GetNextDownlinkFCntForDevEuiResponse>, Status>

GetNextDownlinkFCntForDevEUI returns the next FCnt that must be used. This also takes device-queue items for the given DevEUI into consideration.

pub async fn get_random_dev_addr(
    &mut self,
    request: impl IntoRequest<()>
) -> Result<Response<GetRandomDevAddrResponse>, Status>

GetRandomDevAddr returns a random DevAddr taking the NwkID prefix into account.

pub async fn create_mac_command_queue_item(
    &mut self,
    request: impl IntoRequest<CreateMacCommandQueueItemRequest>
) -> Result<Response<()>, Status>

CreateMACCommandQueueItem adds the downlink mac-command to the queue.

pub async fn send_proprietary_payload(
    &mut self,
    request: impl IntoRequest<SendProprietaryPayloadRequest>
) -> Result<Response<()>, Status>

SendProprietaryPayload send a payload using the ‘Proprietary’ LoRaWAN message-type.

pub async fn create_gateway(
    &mut self,
    request: impl IntoRequest<CreateGatewayRequest>
) -> Result<Response<()>, Status>

CreateGateway creates the given gateway.

pub async fn get_gateway(
    &mut self,
    request: impl IntoRequest<GetGatewayRequest>
) -> Result<Response<GetGatewayResponse>, Status>

GetGateway returns data for a particular gateway.

pub async fn update_gateway(
    &mut self,
    request: impl IntoRequest<UpdateGatewayRequest>
) -> Result<Response<()>, Status>

UpdateGateway updates an existing gateway.

pub async fn delete_gateway(
    &mut self,
    request: impl IntoRequest<DeleteGatewayRequest>
) -> Result<Response<()>, Status>

DeleteGateway deletes a gateway.

pub async fn generate_gateway_client_certificate(
    &mut self,
    request: impl IntoRequest<GenerateGatewayClientCertificateRequest>
) -> Result<Response<GenerateGatewayClientCertificateResponse>, Status>

GenerateGatewayClientCertificate returns TLS certificate gateway authentication / authorization. This endpoint can ony be used when ChirpStack Network Server is configured with a gateway CA certificate and key, which is used for signing the TLS certificate. The returned TLS certificate will have the Gateway ID as Common Name.

pub async fn create_gateway_profile(
    &mut self,
    request: impl IntoRequest<CreateGatewayProfileRequest>
) -> Result<Response<CreateGatewayProfileResponse>, Status>

CreateGatewayProfile creates the given gateway-profile.

pub async fn get_gateway_profile(
    &mut self,
    request: impl IntoRequest<GetGatewayProfileRequest>
) -> Result<Response<GetGatewayProfileResponse>, Status>

GetGatewayProfile returns the gateway-profile given an id.

pub async fn update_gateway_profile(
    &mut self,
    request: impl IntoRequest<UpdateGatewayProfileRequest>
) -> Result<Response<()>, Status>

UpdateGatewayProfile updates the given gateway-profile.

pub async fn delete_gateway_profile(
    &mut self,
    request: impl IntoRequest<DeleteGatewayProfileRequest>
) -> Result<Response<()>, Status>

DeleteGatewayProfile deletes the gateway-profile matching a given id.

pub async fn get_gateway_stats(
    &mut self,
    request: impl IntoRequest<GetGatewayStatsRequest>
) -> Result<Response<GetGatewayStatsResponse>, Status>

GetGatewayStats returns stats of an existing gateway. Deprecated (stats are forwarded to Application Server API).

pub async fn stream_frame_logs_for_gateway(
    &mut self,
    request: impl IntoRequest<StreamFrameLogsForGatewayRequest>
) -> Result<Response<Streaming<StreamFrameLogsForGatewayResponse>>, Status>

StreamFrameLogsForGateway returns a stream of frames seen by the given gateway.

pub async fn stream_frame_logs_for_device(
    &mut self,
    request: impl IntoRequest<StreamFrameLogsForDeviceRequest>
) -> Result<Response<Streaming<StreamFrameLogsForDeviceResponse>>, Status>

StreamFrameLogsForDevice returns a stream of frames seen by the given device.

pub async fn create_multicast_group(
    &mut self,
    request: impl IntoRequest<CreateMulticastGroupRequest>
) -> Result<Response<CreateMulticastGroupResponse>, Status>

CreateMulticastGroup creates the given multicast-group.

pub async fn get_multicast_group(
    &mut self,
    request: impl IntoRequest<GetMulticastGroupRequest>
) -> Result<Response<GetMulticastGroupResponse>, Status>

GetMulticastGroup returns the multicast-group given an id.

pub async fn update_multicast_group(
    &mut self,
    request: impl IntoRequest<UpdateMulticastGroupRequest>
) -> Result<Response<()>, Status>

UpdateMulticastGroup updates the given multicast-group.

pub async fn delete_multicast_group(
    &mut self,
    request: impl IntoRequest<DeleteMulticastGroupRequest>
) -> Result<Response<()>, Status>

DeleteMulticastGroup deletes a multicast-group given an id.

pub async fn add_device_to_multicast_group(
    &mut self,
    request: impl IntoRequest<AddDeviceToMulticastGroupRequest>
) -> Result<Response<()>, Status>

AddDeviceToMulticastGroup adds the given device to the given multicast-group.

pub async fn remove_device_from_multicast_group(
    &mut self,
    request: impl IntoRequest<RemoveDeviceFromMulticastGroupRequest>
) -> Result<Response<()>, Status>

RemoveDeviceFromMulticastGroup removes the given device from the given multicast-group.

pub async fn enqueue_multicast_queue_item(
    &mut self,
    request: impl IntoRequest<EnqueueMulticastQueueItemRequest>
) -> Result<Response<()>, Status>

EnqueueMulticastQueueItem enqueues the given multicast queue-item and increments the frame-counter after enqueueing.

pub async fn flush_multicast_queue_for_multicast_group(
    &mut self,
    request: impl IntoRequest<FlushMulticastQueueForMulticastGroupRequest>
) -> Result<Response<()>, Status>

FlushMulticastQueueForMulticastGroup flushes the multicast device-queue given a multicast-group id.

pub async fn get_multicast_queue_items_for_multicast_group(
    &mut self,
    request: impl IntoRequest<GetMulticastQueueItemsForMulticastGroupRequest>
) -> Result<Response<GetMulticastQueueItemsForMulticastGroupResponse>, Status>

GetMulticastQueueItemsForMulticastGroup returns the queue-items given a multicast-group id.

pub async fn get_version(
    &mut self,
    request: impl IntoRequest<()>
) -> Result<Response<GetVersionResponse>, Status>

GetVersion returns the ChirpStack Network Server version.

pub async fn get_adr_algorithms(
    &mut self,
    request: impl IntoRequest<()>
) -> Result<Response<GetAdrAlgorithmsResponse>, Status>

GetADRAlgorithms returns the available ADR algorithms.

Trait Implementations

impl<T: Clone> Clone for NetworkServerServiceClient<T>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Debug for NetworkServerServiceClient<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.