Struct GnsNetworkMessage 

pub struct GnsNetworkMessage<T>(/* private fields */);

A GameNetworkingSockets message, tagged with its direction.

The library produces ToReceive messages. You create ToSend messages with GnsUtils::allocate_message, and they own their payload through Payload. Both kinds are released when dropped.

Implementations

impl<T> GnsNetworkMessage<T>

pub unsafe fn into_inner(self) -> *mut ISteamNetworkingMessage

Returns the raw *mut ISteamNetworkingMessage and forgets the wrapper.

Safety

You take over releasing the message, for example by calling SteamAPI_SteamNetworkingMessage_t_Release. For a ToSend message that release also runs the m_pfnFreeData callback that Payload installed.

pub fn payload(&self) -> &[u8]

pub fn message_number(&self) -> u64

pub fn time_received(&self) -> SteamNetworkingMicroseconds

Returns the local timestamp at which the message arrived, in microseconds.

The value shares its timebase with GnsUtils::local_timestamp, so compare the two to compute how long a message sat in the receive queue. It is meaningless on a message you allocated yourself.

pub fn lane(&self) -> GnsLaneId

pub fn flags(&self) -> SendFlags

pub fn user_data(&self) -> u64

pub fn connection(&self) -> GnsConnection

pub fn connection_user_data(&self) -> u64

impl GnsNetworkMessage<ToSend>

pub fn set_connection(self, GnsConnection: GnsConnection) -> Self

pub fn set_lane(self, lane: GnsLaneId) -> Self

pub fn set_flags(self, flags: SendFlags) -> Self

pub fn set_user_data(self, userdata: u64) -> Self

Trait Implementations

impl<T> Drop for GnsNetworkMessage<T>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

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

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.