GridMate::CarrierEvents Class Reference

Inherits GridMate::CarrierEventsBase, and GridMate::GridMateEBusTraits.

Public Member Functions
virtual void	OnIncomingConnection (Carrier *carrier, ConnectionID id)
virtual void	OnFailedToConnect (Carrier *carrier, ConnectionID id, CarrierDisconnectReason reason)
virtual void	OnConnectionEstablished (Carrier *carrier, ConnectionID id)
virtual void	OnDisconnect (Carrier *carrier, ConnectionID id, CarrierDisconnectReason reason)
virtual void	OnDriverError (Carrier *carrier, ConnectionID id, const DriverError &error)
	Report all carrier and driver errors! id == InvalidConnectionID if the error is not connection related!
virtual void	OnSecurityError (Carrier *carrier, ConnectionID id, const SecurityError &error)
virtual void	OnRateChange (Carrier *carrier, ConnectionID id, AZ::u32 sendLimitBytesPerSec)
virtual void	OnReceive (Carrier *carrier, ConnectionID id, unsigned char channel)
Public Member Functions inherited from GridMate::CarrierEventsBase
AZStd::string	ReasonToString (CarrierDisconnectReason reason)

Additional Inherited Members
Public Types inherited from GridMate::GridMateEBusTraits
typedef AZStd::recursive_mutex	MutexType
	We do allow running multiple instances gridmate on different threads.
typedef IGridMate *	BusIdType
	Use the GridMate instance as an ID.
Static Public Attributes inherited from GridMate::GridMateEBusTraits
static const AZ::EBusAddressPolicy	AddressPolicy = AZ::EBusAddressPolicy::ById
	Allow multiple instances of gridmate in an unordered_map.

Member Function Documentation

OnRateChange()

virtual void GridMate::CarrierEvents::OnRateChange ( Carrier *  carrier, ConnectionID  id, AZ::u32  sendLimitBytesPerSec  )

inlinevirtual

Notifies of data rate change

The carrier has detected a peer rate change (likely from congestion). Listeners should decrease/increase generation rate to match. This version sends the rate for the lowest rate peer connection, but future versions will update per-peer and add a ConnectionID param.

carrier ptr to carrier id connection with rate change sendLimitBytesPerSec new send rate in bytes per second

OnReceive()

virtual void GridMate::CarrierEvents::OnReceive ( Carrier *  carrier, ConnectionID  id, unsigned char  channel  )

inlinevirtual

Notifies of message arrival

Note: as with all EBUS functions the callee must add thread safety if required

carrier ptr to carrier id connection with new message channel channel receiving message

---

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

• Code/Framework/GridMate/GridMate/Carrier/Carrier.h