Struct opcua_server::state::ServerState

pub struct ServerState {
    pub application_uri: UAString,
    pub product_uri: UAString,
    pub application_name: LocalizedText,
    pub base_endpoint: String,
    pub start_time: DateTime,
    pub namespaces: Vec<String>,
    pub servers: Vec<String>,
    pub config: Arc<RwLock<ServerConfig>>,
    pub server_certificate: Option<X509>,
    pub server_pkey: Option<PrivateKey>,
    pub last_subscription_id: u32,
    pub max_subscriptions: usize,
    pub min_publishing_interval: Duration,
    pub default_keep_alive_count: u32,
    pub max_keep_alive_count: u32,
    pub max_lifetime_count: u32,
    pub max_method_calls: usize,
    pub max_nodes_per_node_management: usize,
    pub max_browse_paths_per_translate: usize,
    pub state: ServerStateType,
    pub abort: bool,
    pub diagnostics: Arc<RwLock<ServerDiagnostics>>,
    // some fields omitted
}

Server state is any state associated with the server as a whole that individual sessions might be interested in. That includes configuration info etc.

Fields

application_uri: UAString

The application URI

product_uri: UAString

The product URI

application_name: LocalizedText

The application name

base_endpoint: String

The protocol, hostname and port formatted as a url, but less the path

start_time: DateTime

The time the server started

namespaces: Vec<String>

The list of namespaces

servers: Vec<String>

The list of servers (by urn)

config: Arc<RwLock<ServerConfig>>

Server configuration

server_certificate: Option<X509>

Server public certificate read from config location or null if there is none

server_pkey: Option<PrivateKey>

Server private key

last_subscription_id: u32

The next subscription id - subscriptions are shared across the whole server. Initial value is a random u32.

max_subscriptions: usize

Maximum number of subscriptions per session, 0 means no limit (danger)

min_publishing_interval: Duration

Minimum publishing interval

default_keep_alive_count: u32

Default keep alive count

max_keep_alive_count: u32

Maxmimum keep alive count

max_lifetime_count: u32

Maximum lifetime count (3 times as large as max keep alive)

max_method_calls: usize

Limits on method service

max_nodes_per_node_management: usize

Limits on node management service

max_browse_paths_per_translate: usize

Limits on view service

state: ServerStateType

abort: bool

Sets the abort flag that terminates the associated server

diagnostics: Arc<RwLock<ServerDiagnostics>>

Diagnostic information

Methods

impl ServerState

pub fn endpoints(
    &self,
    transport_profile_uris: &Option<Vec<UAString>>
) -> Option<Vec<EndpointDescription>>

pub fn endpoint_exists(
    &self,
    endpoint_url: &str,
    security_policy: SecurityPolicy,
    security_mode: MessageSecurityMode
) -> bool

pub fn new_endpoint_descriptions(
    &self,
    endpoint_url: &str
) -> Option<Vec<EndpointDescription>>

Make matching endpoint descriptions for the specified url. If none match then None will be passed, therefore if Some is returned it will be guaranteed to contain at least one result.

pub fn discovery_urls(&self) -> Option<Vec<UAString>>

pub fn application_type(&self) -> ApplicationType

pub fn gateway_server_uri(&self) -> UAString

pub fn abort(&mut self)

pub fn state(&self) -> ServerStateType

pub fn set_state(&mut self, state: ServerStateType)

pub fn is_abort(&self) -> bool

pub fn is_running(&self) -> bool

pub fn max_method_calls(&self) -> usize

pub fn max_nodes_per_node_management(&self) -> usize

pub fn max_browse_paths_per_translate(&self) -> usize

pub fn server_certificate_as_byte_string(&self) -> ByteString

pub fn registered_server(&self) -> RegisteredServer

pub fn create_subscription_id(&mut self) -> u32

pub fn authenticate_endpoint(
    &self,
    endpoint_url: &str,
    security_policy: SecurityPolicy,
    security_mode: MessageSecurityMode,
    user_identity_token: &ExtensionObject
) -> StatusCode

Authenticates access to an endpoint. The endpoint is described by its path, policy, mode and the token is supplied in an extension object that must be extracted and authenticated.

It is possible that the endpoint does not exist, or that the token is invalid / unsupported or that the token cannot be used with the end point. The return codes reflect the responses that ActivateSession would expect from a service call.

pub fn set_register_nodes_callbacks(
    &mut self,
    register_nodes_callback: Box<dyn RegisterNodes + Send + Sync>,
    unregister_nodes_callback: Box<dyn UnregisterNodes + Send + Sync>
)