Skip to main content

OpCode

Enum OpCode 

Source
#[repr(u16)]
pub enum OpCode {
Show 13 variants SessionRequest = 1, SessionResponse = 2, MultiPacket = 3, Disconnect = 5, Heartbeat = 6, NetStatusRequest = 7, NetStatusResponse = 8, ReliableData = 9, ReliableDataFragment = 13, Acknowledge = 17, AcknowledgeAll = 21, UnknownSender = 29, RemapConnection = 30,
}
Expand description

The packet OP codes used in the SOE protocol. All packets are prefixed with a big-endian u16 OP code.

Variants§

§

SessionRequest = 1

Used to request the start of a session.

§

SessionResponse = 2

Used to confirm the start of a session, and set connection details.

§

MultiPacket = 3

Used to encapsulate two or more SOE protocol packets.

§

Disconnect = 5

Used to indicate that a party is closing the session.

§

Heartbeat = 6

Used to keep a session alive when no data has been received for some time.

§

NetStatusRequest = 7

Network status request. Exact usage is not fully understood.

§

NetStatusResponse = 8

Network status response. Exact usage is not fully understood.

§

ReliableData = 9

Used to transfer small buffers of application data.

§

ReliableDataFragment = 13

Used to transfer large buffers of application data in multiple fragments.

§

Acknowledge = 17

Used to acknowledge a single reliable data packet.

§

AcknowledgeAll = 21

Used to acknowledge all reliable data packets up to a particular sequence.

§

UnknownSender = 29

Indicates the receiver has no session associated with the sender’s address.

§

RemapConnection = 30

Used to request that a session be remapped to another port.

Implementations§

Source§

impl OpCode

Source

pub fn from_u16(value: u16) -> Option<Self>

Attempts to convert a raw u16 into an OpCode.

Source

pub fn as_u16(self) -> u16

Returns the raw u16 value of this OP code.

Source

pub fn is_contextless(self) -> bool

Returns true if this packet type is used outside of an established session context (and hence is not CRC-checked or compressed).

Trait Implementations§

Source§

impl Clone for OpCode

Source§

fn clone(&self) -> OpCode

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for OpCode

Source§

impl Debug for OpCode

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for OpCode

Source§

impl Hash for OpCode

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for OpCode

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for OpCode

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.