[][src]Struct file_protocol::protocol::Protocol

pub struct Protocol { /* fields omitted */ }

File protocol information structure

Methods

impl Protocol
[src]

Create a new file protocol instance using an automatically assigned UDP socket

Arguments

  • host_ip - The local IP address
  • remote_addr - The remote IP and port to communicate with
  • prefix - Temporary storage directory prefix

Errors

If this function encounters any errors, it will panic

Examples

use file_protocol::*;

let config = FileProtocolConfig::new(Some("my/file/storage".to_owned()), 4096, 5);
let f_protocol = FileProtocol::new("0.0.0.0", "192.168.0.1:7000", config);

Send CBOR packet to the destination port

Arguments

  • vec - CBOR packet to send

Errors

If this function encounters any errors, it will return an error message string

Examples

extern crate file_protocol;
extern crate serde_cbor;

use file_protocol::*;
use serde_cbor::ser;

let config = FileProtocolConfig::new(None, 4096, 5);
let f_protocol = FileProtocol::new("0.0.0.0", "0.0.0.0:7000", config);
let message = ser::to_vec_packed(&"ping").unwrap();

f_protocol.send(&message);

Receive a file protocol message

Arguments

  • timeout - Maximum time to wait for a reply. If None, will block indefinitely

Errors

  • If this function times out, it will return Err(None)
  • If this function encounters any errors, it will return an error message string

Examples

extern crate file_protocol;

use file_protocol::*;
use std::time::Duration;

let config = FileProtocolConfig::new(None, 4096, 5);
let f_protocol = FileProtocol::new("0.0.0.0", "0.0.0.0:7000", config);

let message = match f_protocol.recv(Some(Duration::from_secs(1))) {
    Ok(data) => data,
    Err(ProtocolError::ReceiveTimeout) =>  {
        println!("Timeout waiting for message");
        return;
    }
    Err(err) => panic!("Failed to receive message: {}", err),
};

Generates a new random channel ID for use when initiating a file transfer.

Errors

If this function encounters any errors, it will return an error message string

Examples

use file_protocol::*;

let config = FileProtocolConfig::new(None, 4096, 5);
let f_protocol = FileProtocol::new("0.0.0.0", "0.0.0.0:7000", config);

let channel_id = f_protocol.generate_channel();

Send a file's metadata information to the remote target

Arguments

  • channel_id - Channel ID for transaction
  • hash - BLAKE2s hash of file
  • num_chunks - Number of data chunks needed for file

Errors

If this function encounters any errors, it will return an error message string

Examples

use file_protocol::*;

let config = FileProtocolConfig::new(None, 4096, 5);
let f_protocol = FileProtocol::new("0.0.0.0", "0.0.0.0:7000", config);


let (hash, num_chunks, _mode) = f_protocol.initialize_file("client.txt").unwrap();
let channel_id = f_protocol.generate_channel().unwrap();
f_protocol.send_metadata(channel_id, &hash, num_chunks);

Send a request to cleanup the remote storage folder

Request remote target to receive file from host

Arguments

  • channel_id - Channel ID used for transaction
  • hash - BLAKE2s hash of file
  • target_path - Destination file path
  • mode - File mode

Errors

If this function encounters any errors, it will return an error message string

Examples

use file_protocol::*;

let config = FileProtocolConfig::new(None, 4096, 5);
let f_protocol = FileProtocol::new("0.0.0.0", "0.0.0.0:7000", config);


let (hash, _num_chunks, mode) = f_protocol.initialize_file("client.txt").unwrap();
let channel_id = f_protocol.generate_channel().unwrap();
f_protocol.send_export(channel_id, &hash, "final/dir/service.txt", mode);

Request a file from a remote target

Arguments

  • source_path - File remote target should send

Errors

If this function encounters any errors, it will return an error message string

Examples

use file_protocol::*;

let config = FileProtocolConfig::new(None, 4096, 5);
let f_protocol = FileProtocol::new("0.0.0.0", "0.0.0.0:7000", config);
let channel_id = f_protocol.generate_channel().unwrap();

f_protocol.send_import(channel_id, "service.txt");

Prepare a file for transfer

Imports the file into temporary storage and calculates the BLAKE2s hash

Arguments

  • source_path - File to initialize for transfer

Errors

If this function encounters any errors, it will return an error message string

Examples

use file_protocol::*;

let config = FileProtocolConfig::new(None, 4096, 5);
let f_protocol = FileProtocol::new("0.0.0.0", "0.0.0.0:7000", config);


let (_hash, _num_chunks, _mode) = f_protocol.initialize_file("client.txt").unwrap();

Listen for and process file protocol messages

Arguments

  • pump - Function which returns the next message for processing
  • timeout - Maximum time to listen for a single message
  • start_state - Current transaction state

Errors

If this function encounters any errors, it will return an error message string

Examples

extern crate file_protocol;

use file_protocol::*;
use std::time::Duration;

let config = FileProtocolConfig::new(None, 4096, 5);
let f_protocol = FileProtocol::new("0.0.0.0", "0.0.0.0:7000", config);

f_protocol.message_engine(
    |d| f_protocol.recv(Some(d)),
    Duration::from_millis(10),
    &State::Transmitting
);

Process a file protocol message

Returns the new transaction state

Arguments

  • message - File protocol message to process
  • state - Current transaction state

Errors

If this function encounters any errors, it will return an error message string

Examples

extern crate file_protocol;

use file_protocol::*;
use std::time::Duration;

let config = FileProtocolConfig::new(None, 4096, 5);
let f_protocol = FileProtocol::new("0.0.0.0", "0.0.0.0:7000", config);

if let Ok(message) = f_protocol.recv(Some(Duration::from_millis(100))) {
    let _state = f_protocol.process_message(
        message,
        &State::StartReceive {
            path: "target/dir/file.bin".to_owned()
        }
    );
}

Auto Trait Implementations

impl Send for Protocol

impl !Sync for Protocol

Blanket Implementations

impl<T> From for T
[src]

Performs the conversion.

impl<T, U> Into for T where
    U: From<T>, 
[src]

Performs the conversion.

impl<T, U> TryFrom for T where
    T: From<U>, 
[src]

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

🔬 This is a nightly-only experimental API. (try_from)

Performs the conversion.

impl<T> Borrow for T where
    T: ?Sized
[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut for T where
    T: ?Sized
[src]

Mutably borrows from an owned value. Read more

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

🔬 This is a nightly-only experimental API. (try_from)

Performs the conversion.

impl<T> Any for T where
    T: 'static + ?Sized
[src]

🔬 This is a nightly-only experimental API. (get_type_id)

this method will likely be replaced by an associated static

Gets the TypeId of self. Read more