Package heronarts.lx.output

Class LXSocket

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.output.LXOutput

heronarts.lx.output.LXBufferOutput

heronarts.lx.output.LXSocket

All Implemented Interfaces:

LXPath, LXSerializable, LXOutput.InetOutput, LXParameterListener

Direct Known Subclasses:

OPCSocket

public abstract class LXSocket
extends LXBufferOutput
implements LXOutput.InetOutput

Nested Class Summary

Nested classes/interfaces inherited from class heronarts.lx.output.LXBufferOutput

LXBufferOutput.ByteEncoder, LXBufferOutput.ByteOrder

Nested classes/interfaces inherited from class heronarts.lx.output.LXOutput

LXOutput.GammaMode, LXOutput.GammaTable, LXOutput.InetOutput

Nested classes/interfaces inherited from class heronarts.lx.LXComponent

LXComponent.Description, LXComponent.Hidden, LXComponent.Name, LXComponent.Placeholder, LXComponent.PluginRequired, LXComponent.Renamable

Nested classes/interfaces inherited from interface heronarts.lx.LXSerializable

LXSerializable.Utils

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_CONNECT_TIMEOUT_MS
protected OutputStream	output
protected Socket	socket

Fields inherited from class heronarts.lx.output.LXBufferOutput

indexBuffer

Fields inherited from class heronarts.lx.output.LXOutput

brightness, enabled, framesPerSecond, gamma, gammaMode, MAX_FRAMES_PER_SECOND, whitePointBlue, whitePointGreen, whitePointRed, whitePointWhite

Fields inherited from class heronarts.lx.LXComponent

childArrays, children, internalParameters, KEY_CHILDREN, KEY_CLASS, KEY_COMPONENT_ID, KEY_ID, KEY_INTERNAL, KEY_PARAMETER_PATH, KEY_PARAMETERS, KEY_PATH, KEY_RESET, label, legacyInternalParameters, legacyParameters, lx, modulationColor, modulationControlsExpanded, modulationsExpanded, parameters, presetFile

Fields inherited from interface heronarts.lx.output.LXOutput.InetOutput

NO_PORT

Fields inherited from interface heronarts.lx.LXPath

DEFAULT_SEPARATOR, ROOT, ROOT_PREFIX, ROOT_SLASH

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LXSocket(LX lx, int[] indexBuffer)
protected	LXSocket(LX lx, int[] indexBuffer, LXBufferOutput.ByteOrder byteOrder)
protected	LXSocket(LX lx, IndexBuffer indexBuffer)

Method Summary

Modifier and Type	Method	Description
protected void	didConnect()	Subclasses may override to take additional actions upon successful connection
protected void	didDisconnect(Exception x)	Subclasses may override to take additional actions upon disconnection
protected void	disconnect(Exception x)
InetAddress	getAddress()
protected byte[]	getPacketData(int[] colors, LXOutput.GammaTable glut, double brightness)
int	getPort()
boolean	isConnected()
protected void	onSend(int[] colors, LXOutput.GammaTable glut, double brightness)	Subclasses implement this to send the data.
LXSocket	setAddress(InetAddress address)
LXSocket	setConnectTimeout(int connectTimeoutMs)
LXSocket	setPort(int port)

Methods inherited from class heronarts.lx.output.LXBufferOutput

getDataBuffer, getDataBufferOffset, updateDataBuffer

Methods inherited from class heronarts.lx.output.LXOutput

error, error, load, log, onParameterChanged, send, send, setGammaDelegate, setGammaTable, setGammaTable, setGroup

Methods inherited from class heronarts.lx.LXComponent

addArray, addChild, addInternalParameter, addLegacyInternalParameter, addLegacyParameter, addParameter, addParameter, addParameters, assertDisposed, contains, copyParameters, dispose, getCategory, getChild, getComponentDescription, getComponentName, getComponentName, getComponentName, getDescription, getId, getLabel, getLX, getOscAddress, getOscLabel, getOscPath, getParameter, getParameters, getParent, getPath, handleOscMessage, hasParameter, isValidOscParameter, loadParameters, loadPreset, removeParameter, removeParameter, removeParameter, removeParameter, save, savePreset, setDescription, setParent, toOscQuery, toOscQuery, toOscQuery, toString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface heronarts.lx.LXPath

getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalPath, getCanonicalPath, isDescendant

Field Details

DEFAULT_CONNECT_TIMEOUT_MS

public static final int DEFAULT_CONNECT_TIMEOUT_MS

See Also:

• Constant Field Values

socket

protected Socket socket

output

protected OutputStream output

Constructor Details

LXSocket

protected LXSocket(LX lx,
 int[] indexBuffer)

LXSocket

protected LXSocket(LX lx,
 int[] indexBuffer,
 LXBufferOutput.ByteOrder byteOrder)

LXSocket

protected LXSocket(LX lx,
 IndexBuffer indexBuffer)

Method Details

setConnectTimeout

public LXSocket setConnectTimeout(int connectTimeoutMs)

setAddress

public LXSocket setAddress(InetAddress address)

Specified by:

setAddress in interface LXOutput.InetOutput

getAddress

public InetAddress getAddress()

Specified by:

getAddress in interface LXOutput.InetOutput

setPort

public LXSocket setPort(int port)

Specified by:

setPort in interface LXOutput.InetOutput

getPort

public int getPort()

Specified by:

getPort in interface LXOutput.InetOutput

isConnected

public boolean isConnected()

didConnect

protected void didConnect()

Subclasses may override to take additional actions upon successful connection

disconnect

protected void disconnect(Exception x)

didDisconnect

protected void didDisconnect(Exception x)

Subclasses may override to take additional actions upon disconnection

Parameters:

x - Exception that caused the disconnect if there was one

onSend

protected void onSend(int[] colors,
 LXOutput.GammaTable glut,
 double brightness)

Description copied from class: LXOutput

Subclasses implement this to send the data.

Specified by:

onSend in class LXOutput

Parameters:

colors - Color values

glut - Look-up table for 0-255 brightness curves

brightness - Master brightness value

getPacketData

protected byte[] getPacketData(int[] colors,
 LXOutput.GammaTable glut,
 double brightness)