@haxall/haxall
    Preparing search index...

    Class SocketConfig

    Configuration options for TCP and UDP sockets. All socket types accept a socket configuration which will be used to configure the socket when it is created.

    A system-wide default socket configuration can be obtained with SocketConfig.cur. You can change the system default by using SocketConfig.setCur.

    See TcpSocket.make, TcpListener.make, UdpSocket.make, MulticastSocket.make

    Hierarchy (View Summary)

    • Obj
      • SocketConfig
    Index

    Constructors

    Properties

    type$: Type

    Methods

    • Parameters

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      Returns void

    • Parameters

      • it: boolean

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      Returns void

    • Controls how long a TcpListener.accept will block before throwing an IOErr timeout exception. null is used to indicate infinite timeout.

      Returns Duration

    • SO_BROADCAST socket option

      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

    • Controls the default timeout used by TcpSocket.connect. A null value indicates a system default timeout (usually wait forever).

      Returns Duration

    • Create a copy of this configuration and then apply any overrides from the it-block.

      Parameters

      • f: (arg0: this) => void

      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

    • The size in bytes for the sys::InStream buffer. A value of 0 or null disables input stream buffing.

      Returns number

    • 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

    • SO_KEEPALIVE option

      Returns boolean

    • The crypto::KeyStore to use when creating secure sockets. If null, the runtime default will be used.

      Returns KeyStore

    • SO_LINGER controls the linger time or set to null to disable linger.

      Returns Duration

    • TCP_NODELAY socket option specifies that send not be delayed to merge packets (Nagle's algorthm).

      Returns boolean

    • The size in bytes for the sys::OutStream buffer. A value of 0 or null disables output stream buffing.

      Returns number

    • SO_RCVBUF option for the size in bytes of the IP stack buffers.

      Returns number

    • SO_TIMEOUT controls the amount of time a socket will block on a read call before throwing an IOErr timeout exception. null is used to indicate an infinite timeout.

      Returns Duration

    • SO_REUSEADDR is used to control the time wait state of a closed socket.

      Returns boolean

    • SO_SNDBUF option for the size in bytes of the IP stack buffers.

      Returns number

    • Convenience to create a copy of this socket configuration and set the connect and receive timeouts to the given duration. Setting to null indicates infinite timeouts.

      Parameters

      Returns this

    • 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

    • The type-of-class byte in the IP packet header.

      For IPv4 this value is detailed in RFC 1349 as the following bitset:

      • IPTOS_LOWCOST (0x02)
      • IPTOS_RELIABILITY (0x04)
      • IPTOS_THROUGHPUT (0x08)
      • IPTOS_LOWDELAY (0x10)

      For IPv6 this is the value placed into the sin6_flowinfo header field.

      Returns number

    • 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

    • The crypto::KeyStore to use for obtaining trusted certificates when creating secure sockets. If null, the runtime default will be used.

      Returns KeyStore

    • 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

    • Get the current, default socket configuration

      Returns SocketConfig

    • 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

    • Create and configure the socket options.

      Parameters

      Returns SocketConfig

    • Set a new default socket configuration. This configuration will only apply to new sockets created after this is called. This method may only be called once to change the default socket configuration.

      Parameters

      Returns void