From 97fce06c4c4aeeb6b971ce9654c0680b66ab2ad8 Mon Sep 17 00:00:00 2001 From: Avril Date: Tue, 14 May 2019 09:16:30 +0100 Subject: [PATCH] update doc --- README | 7 ++++++- cl-sipc.lisp | 10 ++++++++-- 2 files changed, 14 insertions(+), 3 deletions(-) diff --git a/README b/README index 3c3ea01..a15d73f 100644 --- a/README +++ b/README @@ -29,13 +29,18 @@ Functions: ; :binary - pointer to memory (see struct pointer in `pointer.lisp') ; :close - A request to close (the message is always NIL for this type) ;; If an error or message callback returns NIL, the listener is stopped (you still have to call sipc:release()). Otherwise, the return is ignored. + sipc:respond(message value &optional type) ;; send response (note: only valid when handling message) works the same as send() (see below) with additional error responses: + ;; t - success + ;; :response-disabled - SI_NORESP flag was set + ;; :response-invalid - this message cannnot be responded to like this + ;; :response-multi - a response has already been sent (sipc:with-bound-socket (socket-name socket-filename) body) ;; Bind socket from `socket-filename' to new lexical variable `socket-name' and run (progn @body), then relase the socket afterwards. If the socket fails to bind, return nil and do not attempt to execute body. ;; Add `:connect' after socket-filename to connect instead of binding. ;client functions sipc:connect(file) ;; connect to socket `file', returns sd on success, nil on failure. - sipc:send(sd value &ptional type) ;; send `value' to socket `sd' (optionally specify type (see above types), default :string) + sipc:send(sd value &ptional type (keep-response t)) ;; send `value' to socket `sd' (optionally specify type (see above types), default :string). returns the response if one was sent, or t if keep-response if nil or the server did not send one. ;; :string -- value expected to be a string ;; :binary --value expected to be `pointer' struct ;; :close -- value ignored diff --git a/cl-sipc.lisp b/cl-sipc.lisp index 3565a31..ea47977 100644 --- a/cl-sipc.lisp +++ b/cl-sipc.lisp @@ -75,9 +75,9 @@ (t (with-pointer (ptr) value (%siqr-binary sd ptr))))) (defun send (sd value &optional (type :string) (keep-resp t)) - "send to sever on socket sd. + "send to sever on socket sd. example: (with-bound-socket (socket \"file.socket\") (hook socket ...)) - returns (values response(t if none) nil) on success. (values nil ) on failure. + returns (values response(t if none or keep-resp is nil) nil) on success. (values nil ) on failure. error can be: :partial - Could not write whole message :error - send() error @@ -121,6 +121,12 @@ rc))) (defun respond (value &optional (type :string)) + "send a response. (works same as send() but for server instead of client) + additional return values can be: + :response-invalid - this message cannot be responded to + :response-disabled - the client does not want a response + :response-multi - a response has already been sent + " (let ((sd (symbol-value '*response-message*))) (if sd (let ((rc (cond