Simulated Reality SDK 7500c78d v1.30.2.51085 2024-04-26T11:23:03Z
Stable
Public Member Functions | List of all members
SR::NetworkInterface Class Referenceabstract

Interface defining how to send messages between SR applications. More...

#include <networkinterface.h>

Public Member Functions

virtual void send (uint64_t destination, void *payload, uint64_t payloadSize)=0
 Send data over NetworkInterface. More...
 
virtual bool isActive ()=0
 Returns whether the connection is active. More...
 

Detailed Description

Interface defining how to send messages between SR applications.

Member Function Documentation

◆ isActive()

virtual bool SR::NetworkInterface::isActive ( )
pure virtual

Returns whether the connection is active.

Returns
bool indicating whether network messages can be received by this interface

Can be used to determine when related instances can be cleaned up

◆ send()

virtual void SR::NetworkInterface::send ( uint64_t  destination,
void *  payload,
uint64_t  payloadSize 
)
pure virtual

Send data over NetworkInterface.

Parameters
destinationrepresents the remote instance to receive message
payloadlocal address of data to be sent over the NetworkInterface
payloadSizesize in memory of data to be sent over the NetworkInterface

The documentation for this class was generated from the following file: