ecal configuration API introduced (samples how to use it will follow) (#56)

Author: rex-schilasky

README.md

@@ -38,7 +38,7 @@ use rustecal_types_string::StringMessage;
 
 fn main() {
     // Initialize eCAL
-    Ecal::initialize(Some("hello publisher"), EcalComponents::DEFAULT).unwrap();
+    Ecal::initialize(Some("hello publisher"), EcalComponents::DEFAULT, None).unwrap();
 
     // create a string publisher on "hello"
     let publisher = TypedPublisher::<StringMessage>::new("hello").unwrap();
@@ -67,7 +67,7 @@ use rustecal_types_string::StringMessage;
 
 fn main() {
     // Initialize eCAL
-    Ecal::initialize(Some("hello subscriber"), EcalComponents::DEFAULT).unwrap();
+    Ecal::initialize(Some("hello subscriber"), EcalComponents::DEFAULT, None).unwrap();
 
     // create a string subscriber on “hello”
     let mut subscriber = TypedSubscriber::<StringMessage>::new("hello").unwrap();
@@ -99,7 +99,7 @@ use rustecal::service::types::MethodInfo;
 
 fn main() {
     // Initialize eCAL
-    Ecal::initialize(Some("mirror server"), EcalComponents::DEFAULT).unwrap();
+    Ecal::initialize(Some("mirror server"), EcalComponents::DEFAULT, None).unwrap();
 
     // create a service server for "mirror"
     let mut server = ServiceServer::new("mirror").unwrap();
@@ -138,7 +138,7 @@ use rustecal::service::types::ServiceRequest;
 
 fn main() {
     // Initialize eCAL
-    Ecal::initialize(Some("mirror client"), EcalComponents::DEFAULT).unwrap();
+    Ecal::initialize(Some("mirror client"), EcalComponents::DEFAULT, None).unwrap();
 
     // create a service client for "mirror"
     let client = ServiceClient::new("mirror").unwrap();

docs/src/api/ecal.md

@@ -8,7 +8,7 @@ The `Ecal` struct manages initialization and finalization of the eCAL system.
 use rustecal::{Ecal, EcalComponents};
 
 fn main() -> Result<(), Box<dyn std::error::Error>> {
-    Ecal::initialize(Some("my ecal app"), EcalComponents::DEFAULT)?;
+    Ecal::initialize(Some("my ecal app"), EcalComponents::DEFAULT, None)?;
 
     // use publishers, subscribers, clients, server
 

docs/src/examples/binary.md

@@ -8,7 +8,7 @@ use rustecal::{Ecal, EcalComponents, TypedPublisher};
 use rustecal_types_bytes::BytesMessage;
 
 fn main() -> Result<(), Box<dyn std::error::Error>> {
-    Ecal::initialize(Some("blob publisher"), EcalComponents::DEFAULT)?;
+    Ecal::initialize(Some("blob publisher"), EcalComponents::DEFAULT, None)?;
 
     let publisher = TypedPublisher::<BytesMessage>::new("blob")?;
 
@@ -35,7 +35,7 @@ use rustecal::{Ecal, EcalComponents, TypedSubscriber};
 use rustecal_types_bytes::BytesMessage;
 
 fn main() -> Result<(), Box<dyn std::error::Error>> {
-    Ecal::initialize(Some("blob subscriber"), EcalComponents::DEFAULT)?;
+    Ecal::initialize(Some("blob subscriber"), EcalComponents::DEFAULT, None)?;
 
     let mut subscriber = TypedSubscriber::<BytesMessage>::new("blob")?;
     subscriber.set_callback(|message| {

docs/src/examples/json.md

@@ -14,7 +14,7 @@ struct MyData {
 }
 
 fn main() -> Result<(), Box<dyn std::error::Error>> {
-    Ecal::initialize(Some("json publisher"), EcalComponents::DEFAULT)?;
+    Ecal::initialize(Some("json publisher"), EcalComponents::DEFAULT, None)?;
 
     let publisher = TypedPublisher::<JsonMessage<MyData>>::new("hello_json")?;
 
@@ -45,7 +45,7 @@ struct MyData {
 }
 
 fn main() -> Result<(), Box<dyn std::error::Error>> {
-    Ecal::initialize(Some("json subscriber"), EcalComponents::DEFAULT)?;
+    Ecal::initialize(Some("json subscriber"), EcalComponents::DEFAULT, None)?;
 
     let mut subscriber = TypedSubscriber::<JsonMessage<MyData>>::new("hello_json")?;
     subscriber.set_callback(|message| {

docs/src/examples/logging.md

@@ -9,7 +9,7 @@ use std::{thread, time::Duration};
 
 fn main() -> Result<(), Box<dyn std::error::Error>> {
     // Initialize only the logging subsystem
-    Ecal::initialize(Some("logging_receive_sample"), EcalComponents::LOGGING)?;
+    Ecal::initialize(Some("logging_receive_sample"), EcalComponents::LOGGING, None)?;
 
     while Ecal::ok() {
         let entries = Log::get_logging()?;

docs/src/examples/monitoring.md

@@ -9,7 +9,7 @@ use std::{thread, time::Duration};
 
 fn main() -> Result<(), Box<dyn std::error::Error>> {
     // Initialize only the monitoring subsystem
-    Ecal::initialize(Some("monitoring_receive_sample"), EcalComponents::MONITORING)?;
+    Ecal::initialize(Some("monitoring_receive_sample"), EcalComponents::MONITORING, None)?;
 
     while Ecal::ok() {
         let snap = Monitoring::get_snapshot()?;

docs/src/examples/protobuf.md

@@ -15,7 +15,7 @@ use people::Person;
 impl IsProtobufType for Person {}
 
 fn main() -> Result<(), Box<dyn std::error::Error>> {
-    Ecal::initialize(Some("protobuf publisher"), EcalComponents::DEFAULT)?;
+    Ecal::initialize(Some("protobuf publisher"), EcalComponents::DEFAULT, None)?;
 
     let publisher = TypedPublisher::<ProtobufMessage<Person>>::new("person")?;
 
@@ -47,7 +47,7 @@ use people::Person;
 impl IsProtobufType for Person {}
 
 fn main() -> Result<(), Box<dyn std::error::Error>> {
-    Ecal::initialize(Some("protobuf subscriber"), EcalComponents::DEFAULT)?;
+    Ecal::initialize(Some("protobuf subscriber"), EcalComponents::DEFAULT, None)?;
 
     let mut subscriber = TypedSubscriber::<ProtobufMessage<Person>>::new("person")?;
     subscriber.set_callback(|message| {

docs/src/examples/service_client.md

@@ -8,7 +8,7 @@ This example demonstrates how to call a **Mirror Service** using `rustecal`.
 use rustecal::{Ecal, EcalComponents, ServiceClient, ServiceRequest};
 
 fn main() -> Result<(), Box<dyn std::error::Error>> {
-    Ecal::initialize(Some("mirror_client"), EcalComponents::DEFAULT)?;
+    Ecal::initialize(Some("mirror_client"), EcalComponents::DEFAULT, None)?;
 
     let client = ServiceClient::new("mirror_service")?;
 

docs/src/examples/service_server.md

@@ -11,7 +11,7 @@ use rustecal::{Ecal, EcalComponents, ServiceServer};
 use rustecal::service::types::MethodInfo;
 
 fn main() -> Result<(), Box<dyn std::error::Error>> {
-    Ecal::initialize(Some("mirror_server"), EcalComponents::DEFAULT)?;
+    Ecal::initialize(Some("mirror_server"), EcalComponents::DEFAULT, None)?;
 
     let mut server = ServiceServer::new("mirror_service")?;
 

docs/src/examples/string.md

@@ -8,7 +8,7 @@ use rustecal::{Ecal, EcalComponents, TypedPublisher};
 use rustecal_types_string::StringMessage;
 
 fn main() -> Result<(), Box<dyn std::error::Error>> {
-    Ecal::initialize(Some("string publisher"), EcalComponents::DEFAULT)?;
+    Ecal::initialize(Some("string publisher"), EcalComponents::DEFAULT, None)?;
 
     let publisher = TypedPublisher::<StringMessage>::new("hello")?;
 
@@ -31,7 +31,7 @@ use rustecal::{Ecal, EcalComponents, TypedSubscriber};
 use rustecal_types_string::StringMessage;
 
 fn main() -> Result<(), Box<dyn std::error::Error>> {
-    Ecal::initialize(Some("string subscriber"), EcalComponents::DEFAULT)?;
+    Ecal::initialize(Some("string subscriber"), EcalComponents::DEFAULT, None)?;
 
     let mut subscriber = TypedSubscriber::<StringMessage>::new("hello")?;
     subscriber.set_callback(|message| {