diff options
Diffstat (limited to 'libs/luci-lib-nixio/docsrc/nixio.UnifiedIO.lua')
| -rw-r--r-- | libs/luci-lib-nixio/docsrc/nixio.UnifiedIO.lua | 28 |
1 files changed, 14 insertions, 14 deletions
diff --git a/libs/luci-lib-nixio/docsrc/nixio.UnifiedIO.lua b/libs/luci-lib-nixio/docsrc/nixio.UnifiedIO.lua index 6e407ff2ca..6d1d5ea8c6 100644 --- a/libs/luci-lib-nixio/docsrc/nixio.UnifiedIO.lua +++ b/libs/luci-lib-nixio/docsrc/nixio.UnifiedIO.lua @@ -24,15 +24,15 @@ module "nixio.UnifiedIO" -- @class function -- @name UnifiedIO.readall -- @usage This function uses the low-level read function of the descriptor. --- @usage If the length parameter is ommited, this function returns all data +-- @usage If the length parameter is omitted, this function returns all data -- that can be read before an end-of-file, end-of-stream, connection shutdown -- or similar happens. -- @usage If the descriptor is non-blocking this function may fail with EAGAIN. -- @param length Bytes to read (optional) --- @return data that was successfully read if no error occured +-- @return data that was successfully read if no error occurred -- @return - reserved for error code - -- @return - reserved for error message - --- @return data that was successfully read even if an error occured +-- @return data that was successfully read even if an error occurred --- Write a block of data and wait until all data is written. -- @class function @@ -40,10 +40,10 @@ module "nixio.UnifiedIO" -- @usage This function uses the low-level write function of the descriptor. -- @usage If the descriptor is non-blocking this function may fail with EAGAIN. -- @param block Bytes to write --- @return bytes that were successfully written if no error occured +-- @return bytes that were successfully written if no error occurred -- @return - reserved for error code - -- @return - reserved for error message - --- @return bytes that were successfully written even if an error occured +-- @return bytes that were successfully written even if an error occurred --- Create a line-based iterator. -- Lines may end with either \n or \r\n, these control chars are not included @@ -56,7 +56,7 @@ module "nixio.UnifiedIO" -- to stop reading line-based and want to use the read(all) functions instead -- you can pass "true" to the iterator which will flush the buffer -- and return the bufferd data. --- @usage If the limit parameter is ommited, this function uses the nixio +-- @usage If the limit parameter is omitted, this function uses the nixio -- buffersize (8192B by default). -- @usage If the descriptor is non-blocking the iterator may fail with EAGAIN. -- @usage The iterator can be used as an LTN12 source. @@ -69,7 +69,7 @@ module "nixio.UnifiedIO" -- @usage This function uses the low-level read function of the descriptor. -- @usage The blocksize given is only advisory and to be seen as an upper limit, -- if an underlying read returns less bytes the chunk is nevertheless returned. --- @usage If the limit parameter is ommited, the iterator returns data +-- @usage If the limit parameter is omitted, the iterator returns data -- until an end-of-file, end-of-stream, connection shutdown or similar happens. -- @usage The iterator will not buffer so it is safe to mix with calls to read. -- @usage If the descriptor is non-blocking the iterator may fail with EAGAIN. @@ -94,15 +94,15 @@ module "nixio.UnifiedIO" -- @name UnifiedIO.copy -- @usage This function uses the blocksource function of the source descriptor -- and the sink function of the target descriptor. --- @usage If the limit parameter is ommited, data is copied +-- @usage If the limit parameter is omitted, data is copied -- until an end-of-file, end-of-stream, connection shutdown or similar happens. -- @usage If the descriptor is non-blocking the function may fail with EAGAIN. -- @param fdout Target Descriptor -- @param size Bytes to copy (optional) --- @return bytes that were successfully written if no error occured +-- @return bytes that were successfully written if no error occurred -- @return - reserved for error code - -- @return - reserved for error message - --- @return bytes that were successfully written even if an error occured +-- @return bytes that were successfully written even if an error occurred --- Copy data from the current descriptor to another one using kernel-space -- copying if possible. @@ -111,19 +111,19 @@ module "nixio.UnifiedIO" -- @usage This function uses the sendfile() syscall to copy the data or the -- blocksource function of the source descriptor and the sink function -- of the target descriptor as a fallback mechanism. --- @usage If the limit parameter is ommited, data is copied +-- @usage If the limit parameter is omitted, data is copied -- until an end-of-file, end-of-stream, connection shutdown or similar happens. -- @usage If the descriptor is non-blocking the function may fail with EAGAIN. -- @param fdout Target Descriptor -- @param size Bytes to copy (optional) --- @return bytes that were successfully written if no error occured +-- @return bytes that were successfully written if no error occurred -- @return - reserved for error code - -- @return - reserved for error message - --- @return bytes that were successfully written even if an error occured +-- @return bytes that were successfully written even if an error occurred --- Close the descriptor. -- @class function -- @name UnifiedIO.close -- @usage If the descriptor is a TLS-socket the underlying descriptor is -- closed without touching the TLS connection. --- @return true
\ No newline at end of file +-- @return true |