Function | Package: net.rpc | ToC | DocOverview | CGDoc | RelNotes | FAQ | Index | PermutedIndex
| Allegro CL version 10.1 Unrevised from 10.0 to 10.1. 10.0 version

## client-exit

Arguments: client &key wait kill

The kill argument was added in an update released in January, 2007.

This function causes a client image to exit. It returns one of the keywords `:terminating`, `:terminated`, `:closing`, or `:closed`.

#### The client argument

The client argument must be a `client-lisp` instance. The wait argument may be `nil`, a positive integer, the keyword `:wait`, or any other non-`nil` value.

If the client instance is already marked as terminated, the function returns `nil` immediately.

#### The wait keyword argument

If the wait argument is `nil`, the value returned is `:closing`. If the wait argument is a positive integer, it is the number of seconds to wait. If the wait argument is `:wait`, the wait interval is indefinite. If the wait argument is any other non-`nil` value, the wait interval is 30 seconds.

If at the end of the wait interval the connection to the client still appears to be open, the value returned is `:timeout`; otherwise the value is `:closed`.

#### The kill keyword argument

The default behavior of client-exit (when kill is `nil`) is to call the client Lisp and request that it terminate (if the keep flag, returned by client-lisp-keep, is `nil`). When the kill argument is non-`nil` some more aggressive steps may be taken, such as calling the Operating System kill command. The table below lists the possible strategies.

Value of kill argument | Keep Flag Nil | Keep Flag T
End with call | OS Kill | End with call | OS Kill
`nil` | yes | no | no | no
`:force` | yes | no | yes | no
`:kill` | no | yes | no | no
`:killall` | no | yes | no | yes
`:all` | yes | yes | yes | yes
other non-`nil` | yes | yes | no | no

See Running several communicating Allegro CL images in rpc.htm for information on running several Lisp images.

Copyright (c) 1998-2022, Franz Inc. Lafayette, CA., USA. All rights reserved.
This page was not revised from the 10.0 page.
Created 2019.8.20.

|  | ToC | DocOverview | CGDoc | RelNotes | FAQ | Index | PermutedIndex
| Allegro CL version 10.1 Unrevised from 10.0 to 10.1. 10.0 version