jlinker-end

Arguments: &key wait server lisp-file lisp-port verbose error-p preserve-client-calls

A patch release in late July, 2013, upgraded the jlinker version to 7.1 and modified this function to accept the new preserve-client-calls keyword argument. See jlinker.htm for more information in version 7.1.

This function ends a connection.

If lisp-port is non-nil, the lisp-file argument is ignored; the function attempts to stop advertising at the given port. If port is nil but lisp-file is non-nil, then the function attempts to stop advertising at the port specified in the file. If the wait argument is nil, the function returns before the attempts are completed but the attempts continue.

If the wait argument is non-nil (the default) or if the lisp-port or lisp-file arguments are omitted, then this function attempts to close down a connection between Lisp and Java. If a graceful disconnect fails, the connection is aborted unilaterally. If the wait argument is nil, return while attempted disconnects are going on, otherwise return only when the connection is shut down completely.

It is important to call jlinker-end before calling jlinker-init again even if the connection appears to be broken already.

The following keyword arguments alter the behavior jlinker-end:

• verbose: When t, emit status and warning messages. The default is the value of *jlinker-verbose*.
• error-p: this argument determines the behavior of jlinker-end when an error occurs. If the value of this argument is true, an error of type jlinker-error is signaled. If the value is nil, no error is signaled. This argument defaults to the value of *jlinker-error-p*.
• :preserve-client-calls: this argument, if specified, overrides any setting of the same argument that was specified in the call to jlinker-init. Allowable values are nil (use pre-version 7.1 behavior -- any running client calls are killed), a positive integer (wait that number of seconds before killing remaining client calls), any other non-nil value (allow client calls to run to completion). See jlinker-init for more details.

jlinker-end returns one of the following values:

• :jlinker-end: jlinker connection is properly shut down in response to this call
• :wait: jlinker connection was shutdown in another process; this call was waiting for it to finish because wait is true
• :busy: jlinker shutdown is in progress already in another process, return immediately because wait is nil
• nil: immediate return because there is no jlinker connection at all
• a port instance: lisp-file or lisp-port arguments non-nil but wait is nil
• a list: lisp-file or lisp-port arguments non-nil and error-p is nil and an error occurred. The list contains information about the error. The value of wait does not affect this case.
• [jlinker-error signaled so no value returned]: lisp-file or lisp-port arguments non-nil and error-p is true and an error occurred. The value of wait does not affect this case.

See jlinker.htm for more information on the jLinker facility.

Copyright (c) 1998-2019, Franz Inc. Oakland, CA., USA. All rights reserved.
This page was not revised from the 8.2 page.
Created 2012.5.30.