docs.unity3d.com
    Show / Hide Table of Contents

    Class UDPPort

    Opens a UDP port to send and receive data.

    Inheritance
    Object
    NodeRuntime
    UDPPort
    Inherited Members
    NodeRuntime._parent
    NodeRuntime._portList
    NodeRuntime._queryPath
    NodeRuntime._tickCPUTimeNs
    NodeRuntime.Initialize(SystemGraphComponent)
    NodeRuntime.InternalInitialize()
    NodeRuntime.Start()
    NodeRuntime.OnTick(Double, Double, Scheduler.ClockState, Scheduler.Signal)
    NodeRuntime.FixedUpdate()
    NodeRuntime.OnPortAdded(String, Type, String, PortDirection, FieldExtra, IPortType)
    NodeRuntime.OnPortRemoved(String)
    NodeRuntime.InitializeDynamicPorts(SystemGraphComponent)
    NodeRuntime.QueryPath
    NodeRuntime.TickCPUTimeNs
    NodeRuntime.PortDataList
    Namespace: Mechatronics.Messaging
    Syntax
    [NodeCategory("Network", "UDP Port", NodeTick.Asynchronous, LifeCycle.Update, 0F, NodeMode.Standard, false)]
    public class UDPPort : NodeRuntime

    Fields

    address

    Declaration
    [Tooltip("IP Address of the interface to open the port on.")]
    [Field("IP Address", PortDirection.Right, FieldExtra.Read | FieldExtra.Constant)]
    [SerializeField]
    protected PortType<string> address
    Field Value
    Type Description
    PortType<String>

    commBus

    Declaration
    [Tooltip("Communication bus to communicate with other nodes.")]
    [Field("Comm Bus", PortDirection.Left, FieldExtra.Read | FieldExtra.Write)]
    [SerializeField]
    protected PortType<byte[]> commBus
    Field Value
    Type Description
    PortType<Byte[]>

    kBusAddress

    Bus address for this device

    Declaration
    public static byte kBusAddress
    Field Value
    Type Description
    Byte

    port

    Declaration
    [Tooltip("Port number to open(Must be able to open using the system api).")]
    [Field("Port", PortDirection.Right, FieldExtra.Read | FieldExtra.Constant)]
    [SerializeField]
    protected PortType<int> port
    Field Value
    Type Description
    PortType<Int32>

    Methods

    Disable()

    Declaration
    public override void Disable()
    Overrides
    NodeRuntime.Disable()

    Enable(Scheduler.ClockState)

    Forwarded OnEnable Unity event from the parent SystemGraphComponent

    Declaration
    public override void Enable(Scheduler.ClockState clockStatep)
    Parameters
    Type Name Description
    Scheduler.ClockState clockStatep
    Overrides
    NodeRuntime.Enable(Scheduler.ClockState)

    Update()

    Proceses messages in queue.

    Declaration
    public override void Update()
    Overrides
    NodeRuntime.Update()
    Back to top
    Terms of use
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023