ILoopbackLink Interface

Represents a special type of link known as a loopback link.

Definition

Namespace: Wolfram.NETLink
Assembly: Wolfram.NETLink (in Wolfram.NETLink.dll) Version: 2.0.0.0
C#
public interface ILoopbackLink : IMathLink
Implements
IMathLink

Remarks

Loopback links are links that have both ends connected to the same program, much like a FIFO queue. Loopback links are useful as temporary holders of expressions that are being moved between links, or as scratchpads on which expressions can be built up and then transferred to other links in a single call.

Much of the utility of loopback links to users of the C-language MathLink API is obviated by .NET/Link's Expr class, which provides many of the same features in a more accessible way (Expr uses loopback links in its implementation).

Objects of type ILoopbackLink are created by the method.

ILoopbackLink has no methods; it is simply a type that marks certain links as having special properties.

Properties

ComplexType Sets or gets the class that you want to map to Wolfram Language Complex numbers.
(Inherited from IMathLink)
Error Gets the current error state for the link.
(Inherited from IMathLink)
ErrorMessage Gets a textual message describing the current error state for the link.
(Inherited from IMathLink)
Name Gets the name of the link.
(Inherited from IMathLink)
Ready Indicates whether the link has data waiting to be read.
(Inherited from IMathLink)

Methods

BytesToGet Gives the number of bytes that remain to be read in the element that is currently being read in textual form.
(Inherited from IMathLink)
BytesToPut Gives the number of bytes that remain to be sent in the element that is currently being sent in textual form.
(Inherited from IMathLink)
CheckFunction Reads a function name and argument count and requires that it match the specified function name.
(Inherited from IMathLink)
CheckFunctionWithArgCount Reads a function name and argument count and requires that it match the specified function name and arg count.
(Inherited from IMathLink)
ClearError Clears the link error condition, if possible.
(Inherited from IMathLink)
Close Closes the link.
(Inherited from IMathLink)
Connect Waits for the link to be connected.
(Inherited from IMathLink)
Connect(Int64) Waits for the link to be connected for at most the specified number of milliseconds before throwing a MathLinkException.
(Inherited from IMathLink)
CreateMark Creates a mark at the current point in the incoming MathLink data stream.
(Inherited from IMathLink)
DestroyMark Destroys a mark.
(Inherited from IMathLink)
DeviceInformation A low-level function that retrieves special internal information from the MathLink device.
(Inherited from IMathLink)
EndPacket Call when you are finished writing the contents of a single packet.
(Inherited from IMathLink)
Flush Immediately transmits any data buffered for sending over the link.
(Inherited from IMathLink)
GetArgCount Reads the argument count of an expression being read manually.
(Inherited from IMathLink)
GetArray(Type, Int32) Reads an array and discards information about the heads at each level.
(Inherited from IMathLink)
GetArray(Type, Int32, String) Reads an array and records information about the heads at each level.
(Inherited from IMathLink)
GetBoolean Reads the Wolfram Language symbols True or False as a bool.
(Inherited from IMathLink)
GetBooleanArray Reads a list as a one-dimensional array of bools.
(Inherited from IMathLink)
GetByteArray Reads a list as a one-dimensional array of bytes.
(Inherited from IMathLink)
GetByteString Reads a Wolfram Language string as an array of bytes.
(Inherited from IMathLink)
GetCharArray Reads a list as a one-dimensional array of chars.
(Inherited from IMathLink)
GetComplex Reads a complex number. This can be an integer, real, or a Wolfram Language expression with head Complex.
(Inherited from IMathLink)
GetComplexArray Reads a list as a one-dimensional array of complex numbers.
(Inherited from IMathLink)
GetData Gets a specified number of bytes in the textual form of the expression currently being read.
(Inherited from IMathLink)
GetDecimal Reads a Wolfram Language integer or real number or integer as a decimal.
(Inherited from IMathLink)
GetDecimalArray Reads a list as a one-dimensional array of decimals.
(Inherited from IMathLink)
GetDouble Reads a Wolfram Language real number or integer as a double.
(Inherited from IMathLink)
GetDoubleArray Reads a list as a one-dimensional array of doubles.
(Inherited from IMathLink)
GetExpr Reads an arbitrary expression from the link and creates an Expr from it.
(Inherited from IMathLink)
GetExpressionType Gives the type of the current element in the expression currently being read.
(Inherited from IMathLink)
GetFunction Reads a function name and argument count.
(Inherited from IMathLink)
GetInt16Array Reads a list as a one-dimensional array of shorts.
(Inherited from IMathLink)
GetInt32Array Reads a list as a one-dimensional array of ints.
(Inherited from IMathLink)
GetInt64Array Reads a list as a one-dimensional array of longs.
(Inherited from IMathLink)
GetInteger Reads a Wolfram Language integer as a 32-bit integer.
(Inherited from IMathLink)
GetNextExpressionType Gives the type of the next element in the expression currently being read.
(Inherited from IMathLink)
GetObject Reads a single expression off the link and returns an appropriate object.
(Inherited from IMathLink)
GetSingleArray Reads a list as a one-dimensional array of floats.
(Inherited from IMathLink)
GetString Reads a Wolfram Language character string.
(Inherited from IMathLink)
GetStringArray Reads a list as a one-dimensional array of strings.
(Inherited from IMathLink)
GetStringCRLF Reads a Wolfram Language character string and translates newlines into Windows format.
(Inherited from IMathLink)
GetSymbol Reads a Wolfram Language symbol as a string.
(Inherited from IMathLink)
NewPacket Discards the current packet, if it has been partially read. Has no effect if the previous packet was fully read.
(Inherited from IMathLink)
NextPacket "Opens" the next packet arriving on the link.
(Inherited from IMathLink)
PeekExpr Creates an Expr from the current expression, but does not drain it off the link.
(Inherited from IMathLink)
Put(Boolean) Sends a bool value as the Wolfram Language symbol True or False.
(Inherited from IMathLink)
Put(Decimal) Sends a decimal value as an integer or real.
(Inherited from IMathLink)
Put(Double) Sends a double value.
(Inherited from IMathLink)
Put(Int32) Sends an integer value.
(Inherited from IMathLink)
Put(Int64) Sends a long integer value.
(Inherited from IMathLink)
Put(Object) Sends an object, including strings and arrays.
(Inherited from IMathLink)
Put(Array, String) Sends an array object. Unlike Put(object), this method lets you specify the heads you want for each dimension.
(Inherited from IMathLink)
PutArgCount Specifies the argument count for a composite expression being sent manually.
(Inherited from IMathLink)
PutData Used for sending elements in so-called "textual" form.
(Inherited from IMathLink)
PutFunction Sends a function name and argument count.
(Inherited from IMathLink)
PutFunctionAndArgs Sends a function name and its arguments.
(Inherited from IMathLink)
PutMessage Sends a low-level MathLink message.
(Inherited from IMathLink)
PutNext Identifies the type of data element that is to be sent next.
(Inherited from IMathLink)
PutSize Specifies the size in bytes of an element being sent in textual form.
(Inherited from IMathLink)
PutSymbol Sends a symbol.
(Inherited from IMathLink)
SeekMark Resets the current position in the incoming MathLink data stream to an earlier point.
(Inherited from IMathLink)
TransferExpression Reads a complete expression from the named link and writes it to this link.
(Inherited from IMathLink)
TransferToEndOfLoopbackLink Reads the entire contents of a loopback link and writes it to this link.
(Inherited from IMathLink)

Events

MessageArrived Occurs when a low-level MathLink message arrives.
(Inherited from IMathLink)
Yield Occurs periodically when the link is blocking in a reading call.
(Inherited from IMathLink)

See Also