close
close
NAMESYNOPSIS
DESCRIPTION
EXAMPLE
SEE ALSO
KEYWORDS
___________________________
NAME
close − Close an open channel
SYNOPSIS
close channelId ?r(ead)|w(rite)? ___________________________
DESCRIPTION
Closes or half-closes the channel given by channelId.
ChannelId must be an identifier for an open channel such as a Tcl standard channel (stdin, stdout, or stderr), the return value from an invocation of open or socket, or the result of a channel creation command provided by a Tcl extension.
The single-argument form is a simple “full-close”: all buffered output is flushed to the channel’s output device, any buffered input is discarded, the underlying file or device is closed, and channelId becomes unavailable for use.
If the channel is blocking, the command does not return until all output is flushed. If the channel is nonblocking and there is unflushed output, the channel remains open and the command returns immediately; output will be flushed in the background and the channel will be closed when all the flushing is complete.
If channelId is a blocking channel for a command pipeline then close waits for the child processes to complete.
If the channel is shared between interpreters, then close makes channelId unavailable in the invoking interpreter but has no other effect until all of the sharing interpreters have closed the channel. When the last interpreter in which the channel is registered invokes close, the cleanup actions described above occur. See the interp command for a description of channel sharing.
Channels are automatically closed when an interpreter is destroyed and when the process exits. From 8.6 on (TIP#398), nonblocking channels │ are no longer switched to blocking mode when exiting; this guarantees a │ timely exit even when the peer or a communication channel is stalled. │ To ensure proper flushing of stalled nonblocking channels on exit, one │ must now either (a) actively switch them back to blocking or (b) use │ the environment variable TCL_FLUSH_NONBLOCKING_ON_EXIT, which when set │ and not equal to "0" restores the previous behavior.
The command returns an empty string, and may generate an error if an error occurs while flushing output. If a command in a command pipeline created with open returns an error, close generates an error (similar to the exec command.)
The two-argument form is a “half-close”: given a bidirectional channel │ like a socket or command pipeline and a (possibly abbreviated) │ direction, it closes only the sub-stream going in that direction. This │ means a shutdown() on a socket, and a close() of one end of a pipe for │ a command pipeline. Then, the Tcl-level channel data structure is │ either kept or freed depending on whether the other direction is still │ open. │
A single-argument close on an already half-closed bidirectional channel │ is defined to just “finish the job”. A half-close on an already closed │ half, or on a wrong-sided unidirectional channel, raises an error. │
In the case of a command pipeline, the child-reaping duty falls upon │ the shoulders of the last close or half-close, which is thus allowed to │ report an abnormal exit error. │
Currently only sockets and command pipelines support half-close. A │ future extension will allow reflected and stacked channels to do so.
EXAMPLE
This illustrates how you can use Tcl to ensure that files get closed even when errors happen by combining catch, close and return:
proc
withOpenFile {filename channelVar script} {
upvar 1 $channelVar chan
set chan [open $filename]
catch {
uplevel 1 $script
} result options
close $chan
return -options $options $result
}
SEE ALSO
file(n), open(2), socket(2), eof(n), Tcl_StandardChannels(3)
KEYWORDS
blocking, channel, close, nonblocking, half-close
Opportunity
Personal Opportunity - Free software gives you access to billions of dollars of software at no cost. Use this software for your business, personal use or to develop a profitable skill. Access to source code provides access to a level of capabilities/information that companies protect though copyrights. Open source is a core component of the Internet and it is available to you. Leverage the billions of dollars in resources and capabilities to build a career, establish a business or change the world. The potential is endless for those who understand the opportunity.
Business Opportunity - Goldman Sachs, IBM and countless large corporations are leveraging open source to reduce costs, develop products and increase their bottom lines. Learn what these companies know about open source and how open source can give you the advantage.
Free Software
Free Software provides computer programs and capabilities at no cost but more importantly, it provides the freedom to run, edit, contribute to, and share the software. The importance of free software is a matter of access, not price. Software at no cost is a benefit but ownership rights to the software and source code is far more significant.
Free Office Software - The Libre Office suite provides top desktop productivity tools for free. This includes, a word processor, spreadsheet, presentation engine, drawing and flowcharting, database and math applications. Libre Office is available for Linux or Windows.
Free Books
The Free Books Library is a collection of thousands of the most popular public domain books in an online readable format. The collection includes great classical literature and more recent works where the U.S. copyright has expired. These books are yours to read and use without restrictions.
Source Code - Want to change a program or know how it works? Open Source provides the source code for its programs so that anyone can use, modify or learn how to write those programs themselves. Visit the GNU source code repositories to download the source.
Education
Study at Harvard, Stanford or MIT - Open edX provides free online courses from Harvard, MIT, Columbia, UC Berkeley and other top Universities. Hundreds of courses for almost all major subjects and course levels. Open edx also offers some paid courses and selected certifications.
Linux Manual Pages - A man or manual page is a form of software documentation found on Linux/Unix operating systems. Topics covered include computer programs (including library and system calls), formal standards and conventions, and even abstract concepts.
