IPX network functions.

Note: IPS module must be loaded by calling LoadLibrary("ipx") before using!

# Members

#### # inner _ipxDebugNodes

##### Properties:

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

#### # inner _ipxLogData

##### Properties:

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

#### # inner _ipxLogInit

##### Properties:

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

#### # inner IPX

IPX definitions.

##### Properties:

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

# Methods

#### # inner IpxAddressToString(addr)

Convert a node address to a string.

##### Parameters:

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

#### # inner IpxAllNodes(data, nodes)

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}

Check for packet in receive buffer.

Returns:

true if a packet is available.

Type: `boolean`

#### # inner IpxDebug(str)

Send logmessages to logviewer using IPX networking.

##### Parameters:

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

#### # inner IpxFindNodes(num, nodes) → {boolean}

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:

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

Type: `boolean`

#### # inner IpxGetLocalAddress() → {IpxAddress}

Get the local address.

Returns:

an array containing the own address.

Type: `IpxAddress`

#### # inner IpxGetPacket() → {IpxPacket}

Get packet from receive buffer(or NULL).

Returns:

a data packet or null if none available.

Type: `IpxPacket`

#### # inner IpxSend(data, dest)

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()

Close IPX socket (if any).

#### # inner IpxSocketOpen(num)

Open an IPX socket. See IPX for DEFAULT_SOCKET.

##### Parameters:

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

#### # inner IpxStringToAddress(addr) → {IpxAddress}

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:

An array of six numbers.

Type: `IpxAddress`

# Members

#### # inner _ipxDebugNodes

##### Properties:

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

#### # inner _ipxLogData

##### Properties:

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

#### # inner _ipxLogInit

##### Properties:

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

#### # inner IPX

IPX definitions.

##### Properties:

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

# Methods

#### # inner IpxAddressToString(addr)

Convert a node address to a string.

##### Parameters:

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

#### # inner IpxAllNodes(data, nodes)

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}

Check for packet in receive buffer.

Returns:

true if a packet is available.

Type: `boolean`

#### # inner IpxDebug(str)

Send logmessages to logviewer using IPX networking.

##### Parameters:

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

#### # inner IpxFindNodes(num, nodes) → {boolean}

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:

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

Type: `boolean`

#### # inner IpxGetLocalAddress() → {IpxAddress}

Get the local address.

Returns:

an array containing the own address.

Type: `IpxAddress`

#### # inner IpxGetPacket() → {IpxPacket}

Get packet from receive buffer(or NULL).

Returns:

a data packet or null if none available.

Type: `IpxPacket`

#### # inner IpxSend(data, dest)

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()

Close IPX socket (if any).

#### # inner IpxSocketOpen(num)

Open an IPX socket. See IPX for DEFAULT_SOCKET.

##### Parameters:

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

#### # inner IpxStringToAddress(addr) → {IpxAddress}

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:

An array of six numbers.

Type: `IpxAddress`