diff options
Diffstat (limited to 'src/modules')
| -rw-r--r-- | src/modules/objects/KvsObject_ftp.cpp | 29 | ||||
| -rw-r--r-- | src/modules/objects/KvsObject_http.cpp | 14 |
2 files changed, 22 insertions, 21 deletions
diff --git a/src/modules/objects/KvsObject_ftp.cpp b/src/modules/objects/KvsObject_ftp.cpp index cf48999e2..cba762964 100644 --- a/src/modules/objects/KvsObject_ftp.cpp +++ b/src/modules/objects/KvsObject_ftp.cpp @@ -56,18 +56,19 @@ @description: This class provides a standard FTP functionality.[br] @functions: - !fn:$dataAvailableEvent(<data_length>) - This function is called when some data is available to be read: the <data_length> parameter specifies - the length of the available data in bytes.[br] + !fn:$dataAvailableEvent(<data_length>) + This function is called when some data is available to be read.[br] + The <data_length> parameter specifies the length of the available data in bytes.[br] You can use one of the $read* functions to obtain the data. - !fn: <id:integer> $connect(<host:string>,<remote_port:integer>) - Connects to the FTP server host using port port.The command is scheduled, and its execution is performed asynchronously. - The function returns a unique identifier which is passed by commandStarted() and commandFinished().[br] + !fn: <id:integer> $connect(<host:string>,<remote_port:integer>) + Connects to the FTP server host using port port.[br] + The command is scheduled, and its execution is performed asynchronously.[br] + The function returns a unique identifier which is passed by [b]commandStarted()[/b] and [b]commandFinished()[/b]. !fn:$abort() Aborts the current command and deletes all scheduled commands. !fn:<id:integer> $login(<user:string>,<pass:string>) - Logs in to the FTP server with the username user and the password <pass>. - The function returns a unique identifier which is passed by commandStarted() and commandFinished().[br] + Logs in to the FTP server with the username user and the password <pass>.[br] + The function returns a unique identifier which is passed by [b]commandStarted()[/b] and [b]commandFinished()[/b]. !fn:<id:integer> $get(<remotefile:string>,<localfile:string>) Downloads the <remotefile> file from the server. !fn:<id:integer> $put(<localfile:string>,<remotefile:string>) @@ -75,16 +76,16 @@ !fn:<id:integer> $cd(<remotedir:string>) Changes the working directory of the server to <remotedir>. !fn:<id:integer> $list() - Lists the contents of directory dir on the FTP server. + Lists the contents of the directory on the FTP server. !fn: $commandFinishedEvent(<id:integer>,<error:boolean>) - Called by KVIrc when the ftp command identified by id has finished. - error is true if an error occurred during the processing; otherwise error is false. - The default implementation emits the [classfnc]$commandFinished[/classfnc]() signal. + Called by KVIrc when the FTP command identified by id has finished.[br] + Error is true if an error occurred during the processing; otherwise error is false.[br] + The default implementation emits the [classfnc]$commandFinished[/classfnc]() signal.[br] !fn: $listInfoEvent(<dir_entry_name:string>) - This event is triggered for each directory entry found by [classfnc]$list[/classfnc]() command. + This event is triggered for each directory entry found by [classfnc]$list[/classfnc]() command.[br] The default implementation emits the [classfnc]$listInfo[/classfnc]() signal. !fn: $dataTransferProgressEvent(<done:integer>,<total:integer>) - This event is triggered in response to a [classfnc]get[/classfnc]() or [classfnc]put[/classfnc]() request to indicate the current progress of the download or upload. + This event is triggered in response to a [b]get()[/b] or [b]put()[/b] request to indicate the current progress of the download or upload.[br] The default implementation emits the [classfnc]$dataTransferProgress[/classfnc]() signal. @signals: !sg: $commandFinished(<id:integer>,<szCommand:string>,<error:boolean>) diff --git a/src/modules/objects/KvsObject_http.cpp b/src/modules/objects/KvsObject_http.cpp index 2c898a2a3..d8dcf4a55 100644 --- a/src/modules/objects/KvsObject_http.cpp +++ b/src/modules/objects/KvsObject_http.cpp @@ -88,16 +88,16 @@ @functions: !fn: <id:integer>$get(<remote_path:string>,[<local_file: string>]) Sends a get request for path to the server set by [classfnc]$setHost[/classfnc]. - If local_file is not specified readyRead() signal is emitted every time new content data is available to read. + If local_file is not specified [b]readyRead()[/b] signal is emitted every time new content data is available to read. !fn: <id:integer>$post(<remote_path:string>,<post_data:string>,<local_file: string> Sends a post request for path to the server set by [classfnc]$setHost[/classfnc]. - If local_file is not specified readyRead() signal is emitted every time new content data is available to read. + If local_file is not specified [b]readyRead()[/b] signal is emitted every time new content data is available to read. !fn: $abort() Aborts the current request and deletes all scheduled requests. !fn: <id:integer>$setHost(<host:string>,<remote_port:unsigned_integer>) Sets the HTTP server that is used for requests to hostName on port port. The function does not block: the request is scheduled, and its execution is performed asynchronously. - The function returns a unique identifier which is passed by [classfnc]requestStartedEvent()[/classfnc] and [classfnc]requestFinishedEvent()[/classfnc]. + The function returns a unique identifier which is passed by [b]requestStartedEvent()[/b] and [b]requestFinishedEvent()[/b]. When the request is started the requestStarted() signal is emitted. When it is finished the requestFinished() signal is emitted. !fn: <id:integer>$currentId() Returns the identifier of the HTTP request being executed or 0 if there is no request being executed. @@ -129,12 +129,12 @@ !fn: $stateChangedEvent(<connection_state:string>) This event is triggered by the framework when the state of the connection changes. !fn: $readyReadEvent(<response:string>) - This event is triggered by the framework when there is new data read and there is not file specified in [classfnc]get[/classfunc] or [classfnc]post[/classfunc]. - You can call [classfnc]readAll[/classfnc] to reads all the bytes from the response data. + This event is triggered by the framework when there is new data read and there is not file specified in [b]get[/b] or [b]post[/b]. + You can call [b]readAll[/b] to reads all the bytes from the response data. !fn: $sslErrorsEvent(<sslerrors:string>) Returns the list of errors that occurred during the SSL handshake. - Unless you call ignoreSslErrors() from within a slot connected to the signal emited by this event, - the framwork will tear down the connection immediately after emitting the signal. + Unless you call ignoreSslErrors() from within a slot connected to the signal emitted by this event, + the framework will tear down the connection immediately after emitting the signal. @signals: !sg: $requestStarted() This signal is emitted by the default implementation of [classfnc]$requestStartedEvent[/classfnc]. |