web
|
Last change
on this file since f6f3e91 was
f6f3e91,
checked in by Jessica B. Hamrick <jhamrick@…>, 15 years ago
|
|
Preserve directory hierarchy (not sure what happened to it)
|
-
Property mode set to
100644
|
|
File size:
982 bytes
|
| Line | |
|---|
| 1 | =for stopwords |
|---|
| 2 | remctl Allbery |
|---|
| 3 | |
|---|
| 4 | =head1 NAME |
|---|
| 5 | |
|---|
| 6 | remctl_close - Close a remctl connection and free the client object |
|---|
| 7 | |
|---|
| 8 | =head1 SYNOPSIS |
|---|
| 9 | |
|---|
| 10 | #include <remctl.h> |
|---|
| 11 | |
|---|
| 12 | void B<remctl_close>(struct remctl *I<r>); |
|---|
| 13 | |
|---|
| 14 | =head1 DESCRIPTION |
|---|
| 15 | |
|---|
| 16 | remctl_close() cleanly closes any connection to a remote server created |
|---|
| 17 | via remctl_open() for the given client object and then frees the object |
|---|
| 18 | created by remctl_new(). It should be called when the caller is finished |
|---|
| 19 | with a remctl client object to avoid resource leaks. Following the call |
|---|
| 20 | to remctl_close(), the I<r> pointer to the remctl client object is no |
|---|
| 21 | longer valid. |
|---|
| 22 | |
|---|
| 23 | remctl_close() is always successful, even if it is unable to send a clean |
|---|
| 24 | protocol quit command to the remote server. |
|---|
| 25 | |
|---|
| 26 | =head1 SEE ALSO |
|---|
| 27 | |
|---|
| 28 | remctl_new(3), remctl_open(3) |
|---|
| 29 | |
|---|
| 30 | The current version of the remctl library and complete details of the |
|---|
| 31 | remctl protocol are available from its web page at |
|---|
| 32 | L<http://www.eyrie.org/~eagle/software/remctl/>. |
|---|
| 33 | |
|---|
| 34 | =head1 AUTHOR |
|---|
| 35 | |
|---|
| 36 | Russ Allbery <rra@stanford.edu> |
|---|
| 37 | |
|---|
| 38 | =cut |
|---|
Note: See
TracBrowser
for help on using the repository browser.
