GatewayServiceClient

chirpstack_api::api::gateway_service_client

Struct GatewayServiceClient 

Source 
pub struct GatewayServiceClient<T> { /* private fields */ }
Expand description

GatewayService is the service providing API methods for managing gateways.

Implementations§

Source§

impl GatewayServiceClient<Channel>

Source

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.

Source§

impl<T> GatewayServiceClient<T>
where T: GrpcService<Body>, T::Error: Into<StdError>, T::ResponseBody: Body<Data = Bytes> + Send + 'static, <T::ResponseBody as Body>::Error: Into<StdError> + Send,

Source

pub fn new(inner: T) -> Self

Source

pub fn with_origin(inner: T, origin: Uri) -> Self

Source

pub fn with_interceptor<F>( inner: T, interceptor: F, ) -> GatewayServiceClient<InterceptedService<T, F>>
where F: Interceptor, T::ResponseBody: Default, T: Service<Request<Body>, Response = Response<<T as GrpcService<Body>>::ResponseBody>>, <T as Service<Request<Body>>>::Error: Into<StdError> + Send + Sync,

Source

pub fn send_compressed(self, encoding: CompressionEncoding) -> Self

Compress requests with the given encoding.

This requires the server to support it otherwise it might respond with an error.

Source

pub fn accept_compressed(self, encoding: CompressionEncoding) -> Self

Enable decompressing responses.

Source

pub fn max_decoding_message_size(self, limit: usize) -> Self

Limits the maximum size of a decoded message.

Default: 4MB

Source

pub fn max_encoding_message_size(self, limit: usize) -> Self

Limits the maximum size of an encoded message.

Default: usize::MAX

Source

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

Create creates the given gateway.

Source

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

Get returns the gateway for the given Gateway ID.

Source

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

Update updates the given gateway.

Source

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

Delete deletes the gateway matching the given Gateway ID.

Source

pub async fn list( &mut self, request: impl IntoRequest<ListGatewaysRequest>, ) -> Result<Response<ListGatewaysResponse>, Status>

Get the list of gateways.

Source

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

Generate client-certificate for the gateway.

Source

pub async fn get_metrics( &mut self, request: impl IntoRequest<GetGatewayMetricsRequest>, ) -> Result<Response<GetGatewayMetricsResponse>, Status>

GetMetrics returns the gateway metrics.

Source

pub async fn get_duty_cycle_metrics( &mut self, request: impl IntoRequest<GetGatewayDutyCycleMetricsRequest>, ) -> Result<Response<GetGatewayDutyCycleMetricsResponse>, Status>

GetDutyCycleMetrics returns the duty-cycle metrics. Note that only the last 2 hours of data are stored. Currently only per minute aggregation is available.

Source

pub async fn get_relay_gateway( &mut self, request: impl IntoRequest<GetRelayGatewayRequest>, ) -> Result<Response<GetRelayGatewayResponse>, Status>

Get the given Relay Gateway.

Source

pub async fn list_relay_gateways( &mut self, request: impl IntoRequest<ListRelayGatewaysRequest>, ) -> Result<Response<ListRelayGatewaysResponse>, Status>

List the detected Relay Gateways.

Source

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

Update the given Relay Gateway.

Source

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

Delete the given Relay Gateway.

Trait Implementations§

Source§

impl<T: Clone> Clone for GatewayServiceClient<T>

Source§

fn clone(&self) -> GatewayServiceClient<T>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug> Debug for GatewayServiceClient<T>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> !Freeze for GatewayServiceClient<T>

§

impl<T> RefUnwindSafe for GatewayServiceClient<T>
where T: RefUnwindSafe,

§

impl<T> Send for GatewayServiceClient<T>
where T: Send,

§

impl<T> Sync for GatewayServiceClient<T>
where T: Sync,

§

impl<T> Unpin for GatewayServiceClient<T>
where T: Unpin,

§

impl<T> UnwindSafe for GatewayServiceClient<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more