Struct USubscriptionConfiguration

pub struct USubscriptionConfiguration {
    pub authority_name: String,
    pub subscription_command_buffer: usize,
    pub notification_command_buffer: usize,
}

Fields

authority_name: String

subscription_command_buffer: usize

notification_command_buffer: usize

Implementations

impl USubscriptionConfiguration

Holder object for USubscription configuration options; this performs validation of configuration parameters at construction time, and also acts as a LocalUriProvider for an USubscription service based on the given authority name.

pub fn create( authority_name: String, subscription_command_buffer: Option<usize>, notification_command_buffer: Option<usize>, ) -> Result<Arc<USubscriptionConfiguration>, ConfigurationError>

Create an “immutable” (Arc) USubscriptionConfiguration object from a set of configuration parameters.

Note: the default internal command channel buffer size is DEFAULT_COMMAND_BUFFER_SIZE = 1024

Arguments

• authority_name - Authority part of UUri that this USubscription instance is reachable on
• subscription_command_buffer - buffer size for subscription manager commands, defaults to DEFAULT_COMMAND_BUFFER_SIZE when None or 0 is passed
• notification_command_buffer - buffer size for notification manager commands, defaults to DEFAULT_COMMAND_BUFFER_SIZE when None or 0 is passed

Errors

Returns a ConfigurationError in case an invalid Authority string is provided; this is determined via the uriparse crate Authority::try_from() method.

Trait Implementations

impl Clone for USubscriptionConfiguration

fn clone(&self) -> USubscriptionConfiguration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for USubscriptionConfiguration

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

Formats the value using the given formatter.

impl LocalUriProvider for USubscriptionConfiguration

fn get_authority(&self) -> String

Gets the authority used for URIs representing this uEntity’s resources.

fn get_resource_uri(&self, resource_id: u16) -> UUri

Gets a URI that represents a given resource of this uEntity.

fn get_source_uri(&self) -> UUri

Gets the URI that represents the resource that this uEntity expects RPC responses and notifications to be sent to.