Struct ConnectionOption 

pub struct ConnectionOption { /* private fields */ }

Option to connect to Tsurugi server.

See Session::connect().

Examples

use std::sync::Arc;
use tsubakuro_rust_core::prelude::*;

async fn example() -> Result<Arc<Session>, TgError> {
    let credential = Credential::from_user_password("user", Some("password"));

    let mut connection_option = ConnectionOption::new();
    connection_option.set_endpoint_url("tcp://localhost:12345")?;
    connection_option.set_credential(credential);
    connection_option.set_application_name("Tsubakuro/Rust example");
    connection_option.set_session_label("example session");
    connection_option.set_default_timeout(std::time::Duration::from_secs(10));

    let session = Session::connect(&connection_option).await?;

    Ok(session)
}

Implementations

impl ConnectionOption

pub fn new() -> ConnectionOption

Creates a new instance.

pub fn set_endpoint(&mut self, endpoint: Endpoint)

Set endpoint.

pub fn set_endpoint_url(&mut self, endpoint: &str) -> Result<(), TgError>

Set endpoint.

Parameters

• endpoint - endpoint url. (e.g. tcp://localhost:12345)

pub fn endpoint(&self) -> Option<&Endpoint>

Get endpoint.

pub fn set_credential(&mut self, credential: Credential)

Set credential.

since 0.5.0

pub fn credential(&self) -> &Credential

Get credential.

since 0.5.0

pub fn set_validity_period(&mut self, duration: Duration)

Set validity period for UserPasswordCredential.

For internal use.

since 0.5.0

pub fn validity_period(&self) -> Duration

Get validity period.

For internal use.

since 0.5.0

pub fn set_application_name(&mut self, name: &str)

Set application name.

pub fn application_name(&self) -> Option<&String>

Get application name.

pub fn set_session_label(&mut self, label: &str)

Set session label.

pub fn session_label(&self) -> Option<&String>

Get session label

pub fn set_keep_alive(&mut self, keep_alive: Duration)

Set keep alive interval.

Do not keep alive when keep_alive is 0.

pub fn keep_alive(&self) -> Duration

Get keep alive interval.

pub fn add_large_object_path_mapping<T: AsRef<Path>>( &mut self, client_path: T, server_path: &str, )

Adds a path mapping entry for both sending and receiving BLOB/CLOB.

since 0.2.0

pub fn add_large_object_path_mapping_on_send<T: AsRef<Path>>( &mut self, client_path: T, server_path: &str, )

Adds a path mapping entry for sending BLOB/CLOB.

since 0.2.0

pub fn add_large_object_path_mapping_on_recv<T: AsRef<Path>>( &mut self, server_path: &str, client_path: T, )

Adds a path mapping entry for receiving BLOB/CLOB.

since 0.2.0

pub fn set_default_timeout(&mut self, timeout: Duration)

Set default timeout.

pub fn default_timeout(&self) -> Duration

Get default timeout.

pub fn set_send_timeout(&mut self, timeout: Duration)

Set communication send timeout.

pub fn send_timeout(&self) -> Duration

Get communication send timeout.

pub fn set_recv_timeout(&mut self, timeout: Duration)

Set communication recv timeout.

pub fn recv_timeout(&self) -> Duration

Get communication recv timeout.

Trait Implementations

impl Clone for ConnectionOption

fn clone(&self) -> ConnectionOption

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConnectionOption

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

Formats the value using the given formatter.

impl Default for ConnectionOption

fn default() -> Self

Returns the “default value” for a type.