@haxall/haxall
    Preparing search index...

    Class UdpSocket

    UdpSocket manages a UDP/IP datagram endpoint.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    type$: Type

    Methods

    • Bind this socket to the specified local address. If addr is null then the default IpAddr for the local host is selected. If port is null an ephemeral port is selected. Throw IOErr if the port is already bound or the bind fails. Return this.

      Parameters

      Returns this

    • Close this socket. This method is guaranteed to never throw an IOErr. Return true if the socket was closed successfully or false if the socket was closed abnormally.

      Returns boolean

    • Return a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified object:

      this < that   =>  <0
      this == that => 0
      this > that => >0

      This method may also be accessed via the < <= <=> >= and > shortcut operators. If not overridden the default implementation compares the toStr representations. Also see docLang.

      Examples:

      3.compare(8)  =>  -1
      8.compare(3) => 1
      8.compare(8) => 0
      3 <=> 8 => -1 // shortcut for 3.compare(8)

      Parameters

      Returns number

    • Connect this socket to the specified address and port. Once connected packets may only be send to the remote using this socket.

      Parameters

      Returns this

    • Disconnect this socket from its remote address. Do nothing if not connected. Return this.

      Returns this

    • Compare this object to the specified for equality. This method may be accessed via the == and != shortcut operators. If not overridden the default implementation compares for reference equality using the === operator. If this method is overridden, then hash() must also be overridden such that any two objects which return true for equals() must return the same value for hash(). This method must accept null and return false.

      Parameters

      Returns boolean

    • Return a unique hashcode for this object. If a class overrides hash() then it must ensure if equals() returns true for any two objects then they have same hash code.

      Returns number

    • Is this socket bound to a local address and port.

      Returns boolean

    • Is this socket closed.

      Returns boolean

    • Is this socket "connected" to a specific remote host. Since UDP is not session oriented, connected just means we've used connect() to predefine the remote address where we want to send packets.

      Returns boolean

    • Return if this Obj is immutable and safe to share between threads:

      • an instance of a const class
      • the result of toImmutable on List, Map, or Buf
      • a Func object may or may not be immutable - see sys::Func.
      • other instances are assumed mutable and return false

      Returns boolean

    • Get the bound local address or null if unbound.

      Returns IpAddr

    • Get the bound local port or null if unbound.

      Returns number

    • Access the SocketOptions used to tune this socket. The following options apply to UdpSockets:

      • broadcast
      • receiveBufferSize
      • sendBufferSize
      • reuseAddr
      • receiveBufferSize
      • trafficClass Accessing other option fields will throw UnsupportedErr.

      Returns SocketOptions

    • Receive a packet on this socket's bound local address. The resulting packet is filled in with the sender's address and port. This method blocks until a packet is received. If this socket's receiveTimeout option is configured, then receive will timeout with an IOErr.

      The packet data is read into the Buf starting at it's current position. The buffer is not grown - at most Buf.capacity bytes are received. If the received message is longer than the packet's capacity then the message is silently truncated (weird Java behavior). Upon return the Buf size and position are updated to reflect the bytes read. Use sys::Buf.flip to ready the buffer to read from start. If packet is null, then a new packet is created with a capacity of 1kb. The packet data must always be a memory backed buffer.

      Parameters

      Returns UdpPacket

    • Get the remote address or null if not connected to a specific end point.

      Returns IpAddr

    • Get the remote port or null if not connected to a specific end point.

      Returns number

    • Send the packet to its specified remote endpoint. If this is socket is connected to a specific remote address, then the packet's address and port must be null or ArgErr is thrown. Throw IOErr on error.

      The number of bytes sent is buf.remaining; upon return the buf is drained and position is advanced.

      Parameters

      Returns void

    • Get an immutable representation of this instance or throw NotImmutableErr if this object cannot be represented as an immutable:

      • if type is const, return this
      • if already an immutable List, Map, Buf, or Func return this
      • if a List, then attempt to perform a deep clone by calling toImmutable on all items
      • if a Map, then attempt to perform a deep clone by calling toImmutable on all values (keys are already immutable)
      • some Funcs can be made immutable - see sys::Func
      • if a Buf create immutable copy, see sys::Buf
      • any other object throws NotImmutableErr

      Returns Readonly<this>

    • Return a string representation of this object.

      Returns string

    • Trap a dynamic call for handling. Dynamic calls are invoked with the -> shortcut operator:

      a->x        a.trap("x", null)
      a->x() a.trap("x", null)
      a->x = b a.trap("x", [b])
      a->x(b) a.trap("x", [b])
      a->x(b, c) a.trap("x", [b, c])

      The default implementation provided by Obj attempts to use reflection. If name maps to a method, it is invoked with the specified arguments. If name maps to a field and args.size is zero, get the field. If name maps to a field and args.size is one, set the field and return args[0]. Otherwise throw UnknownSlotErr.

      Parameters

      Returns JsObj

    • Get the Type instance which represents this object's class. Also seeType.of or Pod.of.

      Returns Type

    • This method called whenever an it-block is applied to an object. The default implementation calls the function with this, and then returns this.

      Parameters

      • f: (arg0: this) => void

      Returns this

    • Write x.toStr to standard output followed by newline. If x is null then print "null". If no argument is provided then print an empty line.

      Parameters

      Returns void