Class SideChannelManager

Collection of static utilities for managing the registering/unregistering of Unity.MLAgents.SideChannels and the sending/receiving of messages for all the channels.

Inheritance

object

SideChannelManager

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.MLAgents.SideChannels

Assembly: Unity.ML-Agents.dll

Syntax

public static class SideChannelManager

Methods

RegisterSideChannel(SideChannel)

Register a side channel to begin sending and receiving messages. This method is available for environments that have custom side channels. All built-in side channels within the ML-Agents Toolkit are managed internally and do not need to be explicitly registered/unregistered. A side channel may only be registered once.

Declaration

public static void RegisterSideChannel(SideChannel sideChannel)

Parameters

Type	Name	Description
SideChannel	sideChannel	The side channel to register.

UnregisterSideChannel(SideChannel)

Unregister a side channel to stop sending and receiving messages. This method is available for environments that have custom side channels. All built-in side channels within the ML-Agents Toolkit are managed internally and do not need to be explicitly registered/unregistered. Unregistering a side channel that has already been unregistered (or never registered in the first place) has no negative side effects. Note that unregistering a side channel may not stop the Python side from sending messages, but it does mean that sent messages with not result in a call to OnMessageReceived(IncomingMessage). Furthermore, those messages will not be buffered and will, in essence, be lost.

Declaration

public static void UnregisterSideChannel(SideChannel sideChannel)

Parameters

Type	Name	Description
SideChannel	sideChannel	The side channel to unregister.