MathLink (J/Link 4.0 API Documentation)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.wolfram.jlink
Interface MathLink

All Known Subinterfaces:: KernelLink, LoopbackLink

public interface MathLink

MathLink is the low-level interface that is the root of all link objects in J/Link. The methods in MathLink correspond roughly to a subset of those in the C-language MathLink API. Most programmers will deal instead with objects of type KernelLink, a higher-level interface that extends MathLink and incorporates the assumption that the program on the other side of the link is a Mathematica kernel.

You create objects of type MathLink via the MathLinkFactory.createLink() method. Again, though, most programmers will use KernelLink instead of MathLink.

Most MathLink methods throw a MathLinkException if a link-related error occurs. Examples would be calling endPacket() before sending a complete expression, or calling getFunction() when an integer is waiting on the link.

For additional information about these methods, see the J/Link User Guide, and also the MathLink documentation in the Mathematica book. Most of these methods are substantially similar, if not identical, to their C counterparts as documented in the book.

See Also:: KernelLink, MathLinkFactory

Field Summary
`static int`	`BEGINDLGPKT` Constant returned by nextPacket.
`static int`	`CALLPKT` Constant returned by nextPacket.
`static int`	`DISPLAYENDPKT` Constant returned by nextPacket.
`static int`	`DISPLAYPKT` Constant returned by nextPacket.
`static int`	`ENDDLGPKT` Constant returned by nextPacket.
`static int`	`ENTEREXPRPKT` Constant returned by nextPacket.
`static int`	`ENTERTEXTPKT` Constant returned by nextPacket.
`static int`	`EVALUATEPKT` Constant returned by nextPacket.
`static int`	`EXPRESSIONPKT`
`static int`	`FEPKT`
`static int`	`FIRSTUSERPKT`
`static int`	`ILLEGALPKT`
`static int`	`INPUTNAMEPKT` Constant returned by nextPacket.
`static int`	`INPUTPKT` Constant returned by nextPacket.
`static int`	`INPUTSTRPKT` Constant returned by nextPacket.
`static int`	`LASTUSERPKT`
`static int`	`MENUPKT` Constant returned by nextPacket.
`static int`	`MESSAGEPKT` Constant returned by nextPacket.
`static int`	`MLABORTMESSAGE` Used in putMessage() to cause the current Mathematica evaluation to be aborted.
`static int`	`MLE_ARRAY_TOO_SHALLOW`
`static int`	`MLE_BAD_COMPLEX`
`static int`	`MLE_CONNECT_TIMEOUT`
`static int`	`MLE_CREATION_FAILED`
`static int`	`MLE_FIRST_USER_EXCEPTION`
`static int`	`MLE_LINK_IS_NULL`
`static int`	`MLE_NON_ML_ERROR`
`static int`	`MLE_OUT_OF_MEMORY`
`static int`	`MLE_WRAPPED_EXCEPTION`
`static int`	`MLEOK`
`static int`	`MLEUSER`
`static int`	`MLINTERRUPTMESSAGE`
`static int`	`MLTERMINATEMESSAGE`
`static int`	`MLTKERR`
`static int`	`MLTKFUNC` Constant for use in putNext() or returned by getNext() and getType().
`static int`	`MLTKINT` Constant for use in putNext() or returned by getNext() and getType().
`static int`	`MLTKREAL` Constant for use in putNext() or returned by getNext() and getType().
`static int`	`MLTKSTR` Constant for use in putNext() or returned by getNext() and getType().
`static int`	`MLTKSYM` Constant for use in putNext() or returned by getNext() and getType().
`static int`	`OUTPUTNAMEPKT` Constant returned by nextPacket.
`static int`	`RESUMEPKT` Constant returned by nextPacket.
`static int`	`RETURNEXPRPKT` Constant returned by nextPacket.
`static int`	`RETURNPKT` Constant returned by nextPacket.
`static int`	`RETURNTEXTPKT` Constant returned by nextPacket.
`static int`	`SUSPENDPKT` Constant returned by nextPacket.
`static int`	`SYNTAXPKT` Constant returned by nextPacket.
`static int`	`TEXTPKT` Constant returned by nextPacket.
`static int`	`TYPE_BIGDECIMAL` Constant for use in getArray().
`static int`	`TYPE_BIGINTEGER` Constant for use in getArray().
`static int`	`TYPE_BOOLEAN` Constant for use in getArray().
`static int`	`TYPE_BYTE` Constant for use in getArray().
`static int`	`TYPE_CHAR` Constant for use in getArray().
`static int`	`TYPE_COMPLEX` Constant for use in getArray().
`static int`	`TYPE_DOUBLE` Constant for use in getArray().
`static int`	`TYPE_EXPR` Constant for use in getArray().
`static int`	`TYPE_FLOAT` Constant for use in getArray().
`static int`	`TYPE_INT` Constant for use in getArray().
`static int`	`TYPE_LONG` Constant for use in getArray().
`static int`	`TYPE_SHORT` Constant for use in getArray().
`static int`	`TYPE_STRING` Constant for use in getArray().

Method Summary
`void`	`activate()` Same as connect().
`boolean`	`addMessageHandler(java.lang.Class cls, java.lang.Object obj, java.lang.String methName)` Specifies the Java method you want called as a message handler.
`int`	`bytesToGet()` Returns the number of bytes that remain to be read in the element that is currently being read in textual form.
`int`	`bytesToPut()` Gives the number of bytes that remain to be sent in the element that is currently being sent in textual form.
`int`	`checkFunction(java.lang.String f)` Reads a function name and argument count and compares the function name with `f`.
`void`	`checkFunctionWithArgCount(java.lang.String f, int argCount)` Reads a function name and argument count and compares the function name with `f` and the argument count with `argCount`.
`boolean`	`clearError()` Clears the link error condition, if possible.
`void`	`close()` Closes the link.
`void`	`connect()` Connects the link, if it has not already been connected.
`void`	`connect(long timeoutMillis)` Connects the link, but waits at most timeoutMillis for a response from the other side.
`long`	`createMark()` Creates a mark at the current point in the incoming MathLink data stream.
`void`	`destroyMark(long mark)` Destroys a mark.
`void`	`endPacket()` Call it when you are finished writing the contents of a single packet.
`int`	`error()` Gives the code corresponding to the current error state of the link.
`java.lang.String`	`errorMessage()` Gives a textual message describing the current error.
`void`	`flush()` Immediately transmits any data buffered for sending over the link.
`int`	`getArgCount()` Reads the argument count of an expression being read manually.
`java.lang.Object`	`getArray(int type, int depth)` Reads an array of the specified type and depth.
`java.lang.Object`	`getArray(int type, int depth, java.lang.String[] heads)` Reads an array of the specified type and depth and records the heads at each level.
`boolean`	`getBoolean()` Reads the Mathematica symbols True or False as a boolean.
`boolean[]`	`getBooleanArray1()` Reads a list as a one-dimensional array of booleans.
`boolean[][]`	`getBooleanArray2()` Reads an array as a two-dimensional array of booleans.
`byte[]`	`getByteArray1()` Reads a list or array as a one-dimensional array of bytes.
`byte[][]`	`getByteArray2()` Reads an array as a two-dimensional array of bytes.
`byte[]`	`getByteString(int missing)` Reads a Mathematica string as an array of bytes.
`char[]`	`getCharArray1()` Reads a list or array as a one-dimensional array of chars.
`char[][]`	`getCharArray2()` Reads an array as a two-dimensional array of chars.
`java.lang.Object`	`getComplex()` Reads a complex number.
`java.lang.Object[]`	`getComplexArray1()` Reads a list as a one-dimensional array of complex numbers.
`java.lang.Object[][]`	`getComplexArray2()` Reads a matrix as a two-dimensional array of complex numbers.
`java.lang.Class`	`getComplexClass()` Gives the Java class that you have specified to map to Mathematica's Complex numbers.
`byte[]`	`getData(int len)` Gets a specified number of bytes in the textual form of the expression currently being read.
`double`	`getDouble()` Reads a Mathematica real number or integer as a double.
`double[]`	`getDoubleArray1()` Reads a list or array as a one-dimensional array of doubles.
`double[][]`	`getDoubleArray2()` Reads an array as a two-dimensional array of doubles.
`Expr`	`getExpr()` Reads an expression from the link and creates an Expr from it.
`float[]`	`getFloatArray1()` Reads a list or array as a one-dimensional array of floats.
`float[][]`	`getFloatArray2()` Reads an array as a two-dimensional array of floats.
`MLFunction`	`getFunction()` Reads a function name and argument count.
`int[]`	`getIntArray1()` Reads a list or array as a one-dimensional array of ints.
`int[][]`	`getIntArray2()` Reads an array as a two-dimensional array of ints.
`int`	`getInteger()` Reads a Mathematica integer as an int.
`long[]`	`getLongArray1()` Reads a list as a one-dimensional array of longs.
`long[][]`	`getLongArray2()` Reads an array as a two-dimensional array of longs.
`long`	`getLongInteger()` Reads a Mathematica integer as a long.
`int`	`getMessage()` Deprecated.
`int`	`getNext()` Gives the type of the next element in the expression currently being read.
`short[]`	`getShortArray1()` Reads a list or array as a one-dimensional array of shorts.
`short[][]`	`getShortArray2()` Reads an array as a two-dimensional array of shorts.
`java.lang.String`	`getString()` Reads a Mathematica character string.
`java.lang.String[]`	`getStringArray1()` Reads a list as a one-dimensional array of strings.
`java.lang.String[][]`	`getStringArray2()` Reads an array as a two-dimensional array of strings.
`java.lang.String`	`getSymbol()` Reads a Mathematica symbol as a string.
`int`	`getType()` Gives the type of the current element in the expression currently being read.
`boolean`	`messageReady()` Deprecated.
`java.lang.String`	`name()` Gives the name of the link.
`void`	`newPacket()` Discards the current packet, if it has been partially read.
`int`	`nextPacket()` "Opens" the next packet arriving on the link.
`Expr`	`peekExpr()` Creates an Expr from the current expression, but does not drain it off the link.
`void`	`put(boolean b)` Sends the boolean value as the Mathematica symbol True or False.
`void`	`put(double d)` Sends a double value.
`void`	`put(int i)` Sends an integer value.
`void`	`put(long i)` Sends a long value.
`void`	`put(java.lang.Object obj)` Sends an object, including strings and arrays.
`void`	`put(java.lang.Object obj, java.lang.String[] heads)` Sends an array object.
`void`	`putArgCount(int argCount)` Specifies the argument count for a composite expression being sent manually.
`void`	`putByteString(byte[] data)` Sends an array of bytes to Mathematica as a string.
`void`	`putData(byte[] data)` Used for sending elements in textual form.
`void`	`putData(byte[] data, int len)` An alternative form of putData() that lets you specify how many bytes from the array should be sent, rather than just sending the whole thing.
`void`	`putFunction(java.lang.String f, int argCount)` Sends a function name and argument count.
`void`	`putMessage(int msg)` Sends a low-level MathLink message.
`void`	`putNext(int type)` Identifies the type of data element that is to be sent.
`void`	`putSize(int size)` Specifies the size in bytes of an element being sent in textual form.
`void`	`putSymbol(java.lang.String s)` Sends a symbol name.
`boolean`	`ready()` Indicates whether the link has data waiting to be read.
`boolean`	`removeMessageHandler(java.lang.String methName)` Removes a message handler you previously set up with addMessageHandler.
`void`	`seekMark(long mark)` Resets the current position in the incoming MathLink data stream to an earlier point.
`boolean`	`setComplexClass(java.lang.Class cls)` Specifies the class you want to map to Mathematica's Complex numbers.
`void`	`setError(int err)` Sets the link's error state to the specified value.
`boolean`	`setYieldFunction(java.lang.Class cls, java.lang.Object obj, java.lang.String methName)` Sets the Java method you want called as a yield function.
`void`	`transferExpression(MathLink source)` Writes a complete expression from the link `source` to this link.
`void`	`transferToEndOfLoopbackLink(LoopbackLink source)` Writes the entire contents of the LoopbackLink `source` to this link.

Field Detail

ILLEGALPKT

static final int ILLEGALPKT

See Also:: Constant Field Values