Struct flute::sender::Sender

pub struct Sender { /* private fields */ }

FLUTE Sender session Transform objects (files) to ALC/LCT packet

Implementations

impl Sender

pub fn new( endpoint: UDPEndpoint, tsi: u64, oti: &Oti, config: &Config ) -> Sender

Creation of a FLUTE Sender

pub fn subscribe(&mut self, s: Arc<dyn Subscriber>)

Add an observer

pub fn unsubscribe(&mut self, s: Arc<dyn Subscriber>)

Remove an observer

pub fn get_udp_endpoint(&self) -> &UDPEndpoint

Get UDP endpoint

pub fn get_tsi(&self) -> u64

Get TSI

pub fn add_object(&mut self, obj: Box<ObjectDesc>) -> Result<u128>

Add an object to the FDT

After calling this function, a call to publish() to publish your modifications

If a TOI as been set to the ObjectDesc, there is no need to release it

Returns

A Result containing an u128 representing the unique identifier of the added object (TOI), if the operation was successful.

pub fn is_added(&self, toi: u128) -> bool

Check if the object is inside the FDT

pub fn remove_object(&mut self, toi: u128) -> bool

Remove an object from the FDT

After calling this function, a call to publish() to publish your modifications

Warning, if the object is being transferred, the transfer is not canceled

Returns

trueif the object has been removed from the FDT

pub fn nb_objects(&self) -> usize

Number of objects signalled in the FDT

pub fn publish(&mut self, now: SystemTime) -> Result<()>

Publish modification to the FDT An updated version of the FDT will be generated and transferred Multiple modification can be made (ex: several call to ’add_object()`) before publishing a new FDT version

pub fn set_complete(&mut self)

Inform that the FDT is complete, no new object should be added after this call You must not call add_object()after After calling this function, a call to publish() to publish your modifications

pub fn read_close_session(&mut self, _now: SystemTime) -> Vec<u8>

Generate a close_session packet

pub fn allocate_toi(&mut self) -> Arc<Toi>

Allocate a TOI TOI must be either release or assigned to an object and call add_object()`

pub fn fdt_xml_data(&self, now: SystemTime) -> Result<Vec<u8>>

Convert current FDT to XML

pub fn get_objects_in_fdt(&self) -> HashMap<u128, &ObjectDesc>

Get List of objects inside the FDT

pub fn read(&mut self, now: SystemTime) -> Option<Vec<u8>>

Read the next ALC/LCT packet return None if there is no new packet to be transferred ALC/LCT packet should be encapsulated into a UDP/IP payload and transferred via UDP/multicast

Trait Implementations

impl Debug for Sender

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

Formats the value using the given formatter.