Package de.aristaflow.adept2.model.datamanagement

Class ServerUDTInputStream

java.lang.Object

de.aristaflow.adept2.model.common.communication.ServerInputStream

de.aristaflow.adept2.model.datamanagement.ServerUDTInputStream

All Implemented Interfaces:

ServerStream, de.aristaflow.adept2.model.communication.ServerSideProxy, de.aristaflow.adept2.model.communication.TimeTrackingSsProxy, Closeable, AutoCloseable

public class ServerUDTInputStream
extends ServerInputStream

This interface resembles a UDTValue but does not provide all data at once but as requested, that is, the value of this UDTValue will not be provided as a whole but incrementally as requested. This significantly improves memory usage.

See Also:

UDTValue

Nested Class Summary

Nested classes/interfaces inherited from interface de.aristaflow.adept2.model.communication.ServerSideProxy

de.aristaflow.adept2.model.communication.ServerSideProxy.LegacySspCloser, de.aristaflow.adept2.model.communication.ServerSideProxy.ServerSideProxyRemover

Field Summary

Fields

Modifier and Type	Field	Description
protected String	userDefinedTypeName	The name of the user-defined type.

Fields inherited from class de.aristaflow.adept2.model.common.communication.ServerInputStream

aliveTimeExtension, busyThreads, cleanup

Fields inherited from interface de.aristaflow.adept2.model.communication.ServerSideProxy

DEFAULT_ALIVE_TIME

Fields inherited from interface de.aristaflow.adept2.model.communication.TimeTrackingSsProxy

DEFAULT_CLOSE_DEFER_TIME, MAX_ALIVE_TIME_EXTENSION

Constructor Summary

Constructors

Constructor	Description
ServerUDTInputStream(UDTValue value)	Deprecated, for removal: This API element is subject to removal in a future version. Use ServerUDTInputStream(UDTValue, long, long) instead.
ServerUDTInputStream(UDTValue value, long initialAliveTime, long aliveTimeExtension)	Creates a new ServerInputStream for the designated UDTValue.
ServerUDTInputStream(InputStream in, String userDefinedType)	Deprecated, for removal: This API element is subject to removal in a future version. Use ServerUDTInputStream(InputStream, String, long, long) instead.
ServerUDTInputStream(InputStream in, String userDefinedType, long initialAliveTime, long aliveTimeExtension)	Creates a new UDTValue as ServerInputStream that is all data will be transfered as requested.

Method Summary

Modifier and Type	Method	Description
String	getUserDefinedType()	Gets the name (a string) of the user-defined type of this value.

Methods inherited from class de.aristaflow.adept2.model.common.communication.ServerInputStream

available, close, getCloseTime, isBusy, mark, markSupported, read, read, reset, setCloseTime, skip

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.aristaflow.adept2.model.communication.TimeTrackingSsProxy

enter, exit, getRemainingAliveTime, keepAlive

Field Detail

userDefinedTypeName

protected final String userDefinedTypeName

The name of the user-defined type.

Constructor Detail

ServerUDTInputStream

@Deprecated(since="15.0.0",
            forRemoval=true)
public ServerUDTInputStream(InputStream in,
                            String userDefinedType)

Deprecated, for removal: This API element is subject to removal in a future version.

Use ServerUDTInputStream(InputStream, String, long, long) instead.

Creates a new UDTValue as ServerInputStream that is all data will be transfered as requested.

Parameters:

in - The input stream providing the value for this UDTValue.

userDefinedType - The name of the user-defined type of the value. the name of the user defined type

ServerUDTInputStream

public ServerUDTInputStream(InputStream in,
                            String userDefinedType,
                            long initialAliveTime,
                            long aliveTimeExtension)

Creates a new UDTValue as ServerInputStream that is all data will be transfered as requested.

Parameters:

in - The input stream providing the value for this UDTValue. The InputStream will be coupled to this ServerUDTInputStream, so do not close it; clone it if required longer than this ServerUDTInputStream.

userDefinedType - The name of the user-defined type of the value. the name of the user defined type

initialAliveTime - The initial time in milliseconds this server stream remains open before automatically being closed.

aliveTimeExtension - The time in milliseconds to extend the alive time when accessing this server stream.

ServerUDTInputStream

@Deprecated(since="15.0.0",
            forRemoval=true)
public ServerUDTInputStream(UDTValue value)

Deprecated, for removal: This API element is subject to removal in a future version.

Use ServerUDTInputStream(UDTValue, long, long) instead.

Creates a new ServerInputStream for the designated UDTValue.

Parameters:

value - The UDTValue providing the necessary information for the ServerUDTInputStream to create.

ServerUDTInputStream

public ServerUDTInputStream(UDTValue value,
                            long initialAliveTime,
                            long aliveTimeExtension)
                     throws IOException

Creates a new ServerInputStream for the designated UDTValue.

Parameters:

value - The UDTValue providing the necessary information for the ServerUDTInputStream to create. closing will not affect the ServerUDTInputStream.

initialAliveTime - The initial time in milliseconds this server stream remains open before automatically being closed.

aliveTimeExtension - The time in milliseconds to extend the alive time when accessing this server stream.

Throws:

IOException - If there are problems retrieving the input stream from the designated UDTValue, an IOException will be thrown.

Method Detail

getUserDefinedType

public String getUserDefinedType()

Gets the name (a string) of the user-defined type of this value.

Returns:

The name of the user-defined data type of this value.