source: trunk/abcl/src/org/armedbear/lisp/socket.lisp @ 14214

Last change on this file since 14214 was 14214, checked in by Mark Evenson, 8 years ago

EXT:READ-TIMEOUT Fix conversion of time to underlying api.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 4.4 KB
Line 
1;;; socket.lisp
2;;;
3;;; Copyright (C) 2004-2006 Peter Graves
4;;; $Id: socket.lisp 14214 2012-10-24 17:34:18Z mevenson $
5;;;
6;;; This program is free software; you can redistribute it and/or
7;;; modify it under the terms of the GNU General Public License
8;;; as published by the Free Software Foundation; either version 2
9;;; of the License, or (at your option) any later version.
10;;;
11;;; This program is distributed in the hope that it will be useful,
12;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
13;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14;;; GNU General Public License for more details.
15;;;
16;;; You should have received a copy of the GNU General Public License
17;;; along with this program; if not, write to the Free Software
18;;; Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19;;;
20;;; As a special exception, the copyright holders of this library give you
21;;; permission to link this library with independent modules to produce an
22;;; executable, regardless of the license terms of these independent
23;;; modules, and to copy and distribute the resulting executable under
24;;; terms of your choice, provided that you also meet, for each linked
25;;; independent module, the terms and conditions of the license of that
26;;; module.  An independent module is a module which is not derived from
27;;; or based on this library.  If you modify this library, you may extend
28;;; this exception to your version of the library, but you are not
29;;; obligated to do so.  If you do not wish to do so, delete this
30;;; exception statement from your version.
31
32(in-package "EXTENSIONS")
33
34(export '(make-socket make-server-socket server-socket-close socket-accept
35          socket-close get-socket-stream socket-peer-port socket-local-port
36          socket-local-address socket-peer-address
37          read-timeout write-timeout))
38
39
40(defun get-socket-stream (socket &key (element-type 'character) (external-format :default))
41  ":ELEMENT-TYPE must be CHARACTER or (UNSIGNED-BYTE 8); the default is CHARACTER.
42EXTERNAL-FORMAT must be of the same format as specified for OPEN."
43  (cond ((eq element-type 'character))
44        ((reduce #'equal
45                (mapcar #'sys::normalize-type 
46                        (list element-type '(unsigned-byte 8)))))
47        (t
48         (error 'simple-type-error
49                :format-control
50                ":ELEMENT-TYPE must be CHARACTER or (UNSIGNED-BYTE 8).")))
51  (sys::%socket-stream socket element-type external-format))
52
53(defun make-socket (host port)
54  "Create a TCP socket for client communication to HOST on PORT."
55  (sys::%make-socket host port))
56
57(defun make-server-socket (port)
58  "Create a TCP server socket listening for clients on PORT."
59  (sys::%make-server-socket port))
60
61(defun socket-accept (socket)
62  "Block until able to return a new socket for handling a incoming request to the specified server SOCKET."
63  (sys::%socket-accept socket))
64
65(defun socket-close (socket)
66  "Close the client SOCKET."
67  (sys::%socket-close socket))
68
69(defun server-socket-close (socket)
70  "Close the server SOCKET."
71  (sys::%server-socket-close socket))
72
73(declaim (inline %socket-address %socket-port))
74(defun %socket-address (socket address-name)
75  "Return the underlying ADDRESS-NAME for SOCKET."
76   (java:jcall "getHostAddress" (java:jcall-raw address-name socket)))
77
78(defun %socket-port (socket port-name)
79  "Return the PORT-NAME of SOCKET."
80   (java:jcall port-name socket))
81
82(defun socket-local-address (socket)
83   "Returns the local address of the SOCKET as a dotted quad string."
84   (%socket-address socket "getLocalAddress"))
85
86(defun socket-peer-address (socket)
87   "Returns the peer address of the SOCKET as a dotted quad string."
88   (%socket-address socket "getInetAddress"))
89
90(defun socket-local-port (socket)
91   "Returns the local port number of the SOCKET."
92   (%socket-port socket "getLocalPort"))
93
94(defun socket-peer-port (socket)
95   "Returns the peer port number of the given SOCKET."
96   (%socket-port socket "getPort"))
97
98(defun read-timeout (socket seconds)
99  "Time in SECONDS to set local implementation of 'SO_RCVTIMEO' on SOCKET."
100  (java:jcall (java:jmethod "java.net.Socket" "setSoTimeout"  "int")
101              socket
102              (* seconds 1000))) ;; underlying API in ms.
103
104(defun write-timeout (socket seconds)
105  "No-op setting of write timeout to SECONDS on SOCKET."
106  (declare (ignore socket seconds))
107  (warn "Unimplemented.
108
109Timeouts for writes should be implemented by spawning a guardian
110to the thread perfoming the socket write"))
111
112(provide '#:socket)
Note: See TracBrowser for help on using the repository browser.