Struct steamworks::networking_types::NetworkingMessage

pub struct NetworkingMessage<Manager> { /* fields omitted */ }

Implementations

impl<Manager> NetworkingMessage<Manager>

pub fn set_connection(&mut self, connection: &NetConnection<Manager>)

Set the target connection for the connection. Make sure you don’t close or drop the NetConnection before sending your message.

Use this with ListenSocket::send_messages for efficient sending.

pub fn identity_peer(&self) -> NetworkingIdentity

For inbound messages: Who sent this to us? For outbound messages on connections: not used. For outbound messages on the ad-hoc ISteamNetworkingMessages interface: who should we send this to?

pub fn set_identity_peer(&mut self, identity: NetworkingIdentity)

The identity of the sender or, the receiver when used with the NetworkingMessages interface.

pub fn connection_user_data(&self) -> i64

For messages received on connections, this is the user data associated with the connection.

This is usually the same as calling GetConnection() and then fetching the user data associated with that connection, but for the following subtle differences:

• This user data will match the connection’s user data at the time is captured at the time the message is returned by the API. If you subsequently change the userdata on the connection, this won’t be updated.
• This is an inline call, so it’s much faster.
• You might have closed the connection, so fetching the user data would not be possible.

Not used when sending messages,

pub fn message_number(&self) -> MessageNumber

Message number assigned by the sender. This is not used for outbound messages

pub fn send_flags(&self) -> SendFlags

Bitmask of k_nSteamNetworkingSend_xxx flags. For received messages, only the k_nSteamNetworkingSend_Reliable bit is valid. For outbound messages, all bits are relevant

pub fn set_send_flags(&mut self, send_flags: SendFlags)

pub fn channel(&self) -> i32

Bitmask of k_nSteamNetworkingSend_xxx flags. For received messages, only the k_nSteamNetworkingSend_Reliable bit is valid. For outbound messages, all bits are relevant

pub fn set_channel(&mut self, channel: i32)

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

Message payload

pub fn copy_data_into_buffer(&mut self, data: &[u8]) -> Result<(), MessageError>

pub fn set_data(&mut self, data: Vec<u8>) -> Result<(), MessageError>

Set a new buffer for the message.

Returns Err(MessageError::BufferAlreadySet) if the current buffer is not NULL.

pub fn user_data(&self) -> i64

Arbitrary user data that you can use when sending messages using ISteamNetworkingUtils::AllocateMessage and ISteamNetworkingSockets::SendMessage. (The callback you set in m_pfnFreeData might use this field.)

Not used for received messages.

pub fn set_user_data(&mut self, user_data: i64)

Arbitrary user data that you can use when sending messages using ISteamNetworkingUtils::AllocateMessage and ISteamNetworkingSockets::SendMessage. (The callback you set in m_pfnFreeData might use this field.)

Not used for received messages.

Trait Implementations

impl<Manager> Drop for NetworkingMessage<Manager>

fn drop(&mut self)

Executes the destructor for this type.