Struct amethyst_network::NetConnection

source ·

pub struct NetConnection<E: 'static> {
    pub target: SocketAddr,
    pub state: ConnectionState,
    pub send_buffer: EventChannel<NetEvent<E>>,
    pub receive_buffer: EventChannel<NetEvent<E>>,
    /* private fields */
}

Expand description

A network connection target data.

Fields

target: SocketAddr

The remote socket address of this connection.

state: ConnectionState

The state of the connection.

send_buffer: EventChannel<NetEvent<E>>

The buffer of events to be sent.

receive_buffer: EventChannel<NetEvent<E>>

The buffer of events that have been received.

Implementations

source

impl<E: Send + Sync + 'static> NetConnection<E>

source

pub fn new(target: SocketAddr) -> Self

Construct a new NetConnection. SocketAddr is the address that will be connected to.

source

pub fn send_buffer_early_read(&mut self) -> EventIterator<'_, NetEvent<E>>

Function used ONLY by NetSocketSystem. Since most users will want to both create the connection and send messages on the same frame, we need a way to read those. Since the NetSocketSystem runs after the creation of the NetConnection, it cannot possibly have registered his reader early enough to catch the initial messages that the user wants to send.

The downside of this is that you are forced to take NetConnection mutably inside of NetSocketSystem. If someone finds a better solution, please open a PR.

Trait Implementations

source

impl<E: Send + Sync + 'static> Component for NetConnection<E>

type Storage = VecStorage<NetConnection<E>>

Associated storage type for this component.

source

impl<E> PartialEq<NetConnection<E>> for NetConnection<E>

source

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

source

impl<E: 'static> Serialize for NetConnection<E>

source

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>where
S: Serializer,

Serialize this value into the given Serde serializer. Read more

source

impl<E: PartialEq> Eq for NetConnection<E>

Auto Trait Implementations

impl<E> !RefUnwindSafe for NetConnection<E>

impl<E> Send for NetConnection<E>where
E: Send + Sync,

impl<E> Sync for NetConnection<E>where
E: Sync,

impl<E> Unpin for NetConnection<E>where
E: Unpin,

impl<E> UnwindSafe for NetConnection<E>where
E: UnwindSafe + RefUnwindSafe,

Blanket Implementations

source

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

source

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

unsafe fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

source

impl<T, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<T> Erased for T

source

impl<T> Event for Twhere
T: 'static + Send + Sync,

source

Struct amethyst_network::NetConnection

Fields

Implementations

impl<E: Send + Sync + 'static> NetConnection<E>

pub fn new(target: SocketAddr) -> Self

pub fn send_buffer_early_read(&mut self) -> EventIterator<'_, NetEvent<E>>

Trait Implementations

impl<E: Send + Sync + 'static> Component for NetConnection<E>

type Storage = VecStorage<NetConnection<E>>

impl<E> PartialEq<NetConnection<E>> for NetConnection<E>

fn eq(&self, other: &Self) -> bool

fn ne(&self, other: &Rhs) -> bool

impl<E: 'static> Serialize for NetConnection<E>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

impl<E: PartialEq> Eq for NetConnection<E>

Auto Trait Implementations

impl<E> !RefUnwindSafe for NetConnection<E>

impl<E> Send for NetConnection<E>where E: Send + Sync,

impl<E> Sync for NetConnection<E>where E: Sync,

impl<E> Unpin for NetConnection<E>where E: Unpin,

impl<E> UnwindSafe for NetConnection<E>where E: UnwindSafe + RefUnwindSafe,

Blanket Implementations

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Any for Twhere T: Any,

fn get_type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

type Init = T

unsafe fn init(init: <T as Pointable>::Init) -> usize

unsafe fn deref<'a>(ptr: usize) -> &'a T

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

unsafe fn drop(ptr: usize)

impl<T> Same<T> for T

type Output = T

impl<SS, SP> SupersetOf<SS> for SPwhere SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

fn is_in_subset(&self) -> bool

unsafe fn to_subset_unchecked(&self) -> SS

fn from_subset(element: &SS) -> SP

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> Erased for T

impl<T> Event for Twhere T: 'static + Send + Sync,

impl<T> Resource for Twhere T: Any + Send + Sync,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>where
S: Serializer,

impl<E> Send for NetConnection<E>where
E: Send + Sync,

impl<E> Sync for NetConnection<E>where
E: Sync,

impl<E> Unpin for NetConnection<E>where
E: Unpin,

impl<E> UnwindSafe for NetConnection<E>where
E: UnwindSafe + RefUnwindSafe,

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Any for Twhere
T: Any,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

impl<T> Event for Twhere
T: 'static + Send + Sync,

impl<T> Resource for Twhere
T: Any + Send + Sync,