diff --git a/nselib/match.lua b/nselib/match.lua index 478b647f3..682246be6 100644 --- a/nselib/match.lua +++ b/nselib/match.lua @@ -1,7 +1,7 @@ --- Buffered network I/O helper functions. --- \n\n --- The functions in this module can be used for delimiting data received --- by the receive_buf function in the Network I/O API. +-- +-- The functions in this module can be used for delimiting data received by the +-- nmap.receive_buf() function in the Network I/O API (which see). -- @copyright Same as Nmap--See http://nmap.org/book/man-legal.html module(... or "match", package.seeall) @@ -10,19 +10,21 @@ require "pcre" --various functions for use with nse's nsock:receive_buf - function -- e.g. --- sock:receivebuf(regex("myregexpattern")) - does a match using pcre- regular- --- - expressions --- sock:receivebuf(numbytes(80)) - is the buffered version of --- sock:receive_bytes(80) - i.e. it returns --- exactly 80 bytes and no more +-- sock:receive_buf(regex("myregexpattern")) - does a match using pcre- regular- +-- - expressions +-- sock:receive_buf(numbytes(80)) - is the buffered version of +-- sock:receive_bytes(80) - i.e. it returns +-- exactly 80 bytes and no more --- Return a function that allows delimiting with a regular expression. --- \n\n --- This function is a wrapper around the exec function of the pcre --- library. It purpose is to give script developers the ability to use --- regular expressions for delimiting instead of Lua's string patterns. --- @param The regex. --- @usage sock:receivebuf(regex("myregexpattern")) +-- +-- This function is a wrapper around pcre.exec. Its purpose is to +-- give script developers the ability to use regular expressions for delimiting +-- instead of Lua's string patterns. +-- @param pattern The regex. +-- @usage sock:receive_buf(match.regex("myregexpattern")) +-- @see nmap.receive_buf +-- @see pcre.exec regex = function(pattern) local r = pcre.new(pattern, 0,"C") @@ -33,14 +35,14 @@ regex = function(pattern) end --- Return a function that allows delimiting at a certain number of bytes. --- \n\n +-- -- This function can be used to get a buffered version of --- sockobj:receive_bytes(n) in case a script requires more than one --- fixed-size chunk, as the unbuffered version may return more bytes --- than requested and thus would require you to do the parsing on your --- own. +-- sock:receive_bytes(n) in case a script requires more than one +-- fixed-size chunk, as the unbuffered version may return more bytes than +-- requested and thus would require you to do the parsing on your own. -- @param num Number of bytes. --- @usage sock:receivebuf(numbytes(80)) +-- @usage sock:receive_buf(match.numbytes(80)) +-- @see nmap.receive_buf numbytes = function(num) local n = num return function(buf)