Instance Method

close(flags:)

Closes the channel to new read and write operations.

Declaration

func close(flags: DispatchIO.CloseFlags = [])

Parameters

flags

The options to use when closing the channel. For a list of possible values, see DispatchIO.CloseFlags.

Discussion

After calling this method, do not schedule any more read or write operations on the channel. Doing so causes an error to be sent to your handler.

If the stop option is specified in the flags parameter, the system attempts to interrupt any outstanding read and write operations on the I/O channel. If you specify this flag, the corresponding handlers may be invoked with partial results. In addition, the final invocation of the handler is passed the POSIXErrorCode.ECANCELED error code to indicate that the operation was interrupted. If you do not specify the stop flag, read and write operations on the channel run to completion as normal.

See Also

Closing the File

struct DispatchIO.CloseFlags

Additional flags to use when closing an I/O channel.