## ipx

IPX network functions.

### Members

#### inner _ipxDebugNodes
`jsboot/ipx.js`, `line 143`

  ##### Properties:

  Name | Type | Description
  --- | --- | ---
  `_ipxDebugNodes` | Array.<IpxAddress> | node list with the logviewer entry.

#### inner _ipxLogData
`jsboot/ipx.js`, `line 133`

  ##### Properties:

  Name | Type | Description
  --- | --- | ---
  `_ipxLogData` | string | remaining data to send to log viewer.

#### inner _ipxLogInit
`jsboot/ipx.js`, `line 138`

  ##### Properties:

  Name | Type | Description
  --- | --- | ---
  `_ipxLogInit` | boolean | indicates if the IPX socket was already opened.

#### inner IPX
`jsboot/ipx.js`, `line 30`

  IPX definitions.

  ##### Properties:

  Name | Type | Description
  --- | --- | ---
  `DEFAULT_SOCKET` | * | default socket number for DOjS.
  `BROADCAST` | * | broadcast address

### Methods

#### inner IpxAddressToString(addr)
`jsboot/ipx.js`, `line 43`

  Convert a node address to a string.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `addr` | IpxAddress | a node address.

#### inner IpxAllNodes(data, nodes)
`jsboot/ipx.js`, `line 124`

  Send data to all nodes in array.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `data` | string | the data to send
  `nodes` | Array.<IpxAddress> | the node addresses to send to.

#### inner IpxCheckPacket() → {boolean}
`doc/internal.js`, `line 84`

  Check for packet in receive buffer.

  ##### Returns:

  boolean - true if a packet is available.

#### inner IpxDebug(str)
`jsboot/ipx.js`, `line 150`

  Send logmessages to logviewer using IPX networking.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `str` | string | logmessage to send.

#### inner IpxFindNodes(num, nodes) → {boolean}
`jsboot/ipx.js`, `line 86`

  discover nodes on the network.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `num` | integer | total number of nodes to search for (including the local node).
  `nodes` | Array.<IpxAddress> | an array to store the discovered nodes in.

  ##### Returns:

  boolean - true if the wanted number of nodes was discovered, else false. The nodes array will contain the addresses of all found nodes.

#### inner IpxGetLocalAddress() → {IpxAddress}
`doc/internal.js`, `line 96`

  Get the local address.

  ##### Returns:

  IpxAddress - an array containing the own address.

#### inner IpxGetPacket() → {IpxPacket}
`doc/internal.js`, `line 90`

  Get packet from receive buffer(or NULL).

  ##### Returns:

  IpxPacket - a data packet or null if none available.

#### inner IpxSend(data, dest)
`doc/internal.js`, `line 78`

  Send packet via IPX. Max length 79 byte. Node addresses are arrays of 6 numbers between 0-255. See IPX for BROADCAST address.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `data` | string | data to send.
  `dest` | IpxAddress | destination address.

#### inner IpxSocketClose()
`doc/internal.js`, `line 71`

  Close IPX socket (if any).

#### inner IpxSocketOpen(num)
`doc/internal.js`, `line 66`

  Open an IPX socket. See IPX for DEFAULT_SOCKET.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `num` | * | the socket number to use.

#### inner IpxStringToAddress(addr) → {IpxAddress}
`jsboot/ipx.js`, `line 62`

  Convert an address in hex-string notation back to an JS array.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `addr` | * | a string of 6 hex numbers separated by ':'.

  ##### Returns:

  IpxAddress - An array of six numbers.

## ipx

### Members

#### inner _ipxDebugNodes
`jsboot/ipx.js`, `line 143`

  ##### Properties:

  Name | Type | Description
  --- | --- | ---
  `_ipxDebugNodes` | Array.<IpxAddress> | node list with the logviewer entry.

#### inner _ipxLogData
`jsboot/ipx.js`, `line 133`

  ##### Properties:

  Name | Type | Description
  --- | --- | ---
  `_ipxLogData` | string | remaining data to send to log viewer.

#### inner _ipxLogInit
`jsboot/ipx.js`, `line 138`

  ##### Properties:

  Name | Type | Description
  --- | --- | ---
  `_ipxLogInit` | boolean | indicates if the IPX socket was already opened.

#### inner IPX
`jsboot/ipx.js`, `line 30`

  IPX definitions.

  ##### Properties:

  Name | Type | Description
  --- | --- | ---
  `DEFAULT_SOCKET` | * | default socket number for DOjS.
  `BROADCAST` | * | broadcast address

### Methods

#### inner IpxAddressToString(addr)
`jsboot/ipx.js`, `line 43`

  Convert a node address to a string.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `addr` | IpxAddress | a node address.

#### inner IpxAllNodes(data, nodes)
`jsboot/ipx.js`, `line 124`

  Send data to all nodes in array.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `data` | string | the data to send
  `nodes` | Array.<IpxAddress> | the node addresses to send to.

#### inner IpxCheckPacket() → {boolean}
`doc/internal.js`, `line 84`

  Check for packet in receive buffer.

  ##### Returns:

  boolean - true if a packet is available.

#### inner IpxDebug(str)
`jsboot/ipx.js`, `line 150`

  Send logmessages to logviewer using IPX networking.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `str` | string | logmessage to send.

#### inner IpxFindNodes(num, nodes) → {boolean}
`jsboot/ipx.js`, `line 86`

  discover nodes on the network.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `num` | integer | total number of nodes to search for (including the local node).
  `nodes` | Array.<IpxAddress> | an array to store the discovered nodes in.

  ##### Returns:

  boolean - true if the wanted number of nodes was discovered, else false. The nodes array will contain the addresses of all found nodes.

#### inner IpxGetLocalAddress() → {IpxAddress}
`doc/internal.js`, `line 96`

  Get the local address.

  ##### Returns:

  IpxAddress - an array containing the own address.

#### inner IpxGetPacket() → {IpxPacket}
`doc/internal.js`, `line 90`

  Get packet from receive buffer(or NULL).

  ##### Returns:

  IpxPacket - a data packet or null if none available.

#### inner IpxSend(data, dest)
`doc/internal.js`, `line 78`

  Send packet via IPX. Max length 79 byte. Node addresses are arrays of 6 numbers between 0-255. See IPX for BROADCAST address.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `data` | string | data to send.
  `dest` | IpxAddress | destination address.

#### inner IpxSocketClose()
`doc/internal.js`, `line 71`

  Close IPX socket (if any).

#### inner IpxSocketOpen(num)
`doc/internal.js`, `line 66`

  Open an IPX socket. See IPX for DEFAULT_SOCKET.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `num` | * | the socket number to use.

#### inner IpxStringToAddress(addr) → {IpxAddress}
`jsboot/ipx.js`, `line 62`

  Convert an address in hex-string notation back to an JS array.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `addr` | * | a string of 6 hex numbers separated by ':'.

  ##### Returns:

  IpxAddress - An array of six numbers.