sockets/base-sockets.lisp

   1 ;; -*- Mode: Lisp; Syntax: ANSI-Common-Lisp -*-
   2
   3 ;;   Copyright (C) 2006, 2007 Stelian Ionescu
   4 ;;
   5 ;;   This code is free software; you can redistribute it and/or
   6 ;;   modify it under the terms of the version 2.1 of
   7 ;;   the GNU Lesser General Public License as published by
   8 ;;   the Free Software Foundation, as clarified by the
   9 ;;   preamble found here:
  10 ;;       http://opensource.franz.com/preamble.html
  11 ;;
  12 ;;   This program is distributed in the hope that it will be useful,
  13 ;;   but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 ;;   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 ;;   GNU General Public License for more details.
  16 ;;
  17 ;;   You should have received a copy of the GNU Lesser General
  18 ;;   Public License along with this library; if not, write to the
  19 ;;   Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  20 ;;   Boston, MA 02110-1301, USA
  21
  22 (in-package :net.sockets)
  23
  24 ;;;;;;;;;;;;;;;
  25 ;;;         ;;;
  26 ;;; Sockets ;;;
  27 ;;;         ;;;
  28 ;;;;;;;;;;;;;;;
  29
  30 (defclass socket (dual-channel-single-fd-mixin)
  31   ((family   :initarg :family   :accessor socket-family)
  32    (protocol :initarg :protocol :accessor socket-protocol)
  33    (bound    :initform nil      :reader   socket-bound-p :type boolean)))
  34
  35 (defgeneric socket-fd (socket))
  36 (defgeneric (setf socket-fd) (fd socket))
  37
  38 (defgeneric socket-type (socket))
  39
  40 (defgeneric socket-open-p (socket))
  41
  42 (defgeneric local-name (socket))
  43
  44 (defgeneric local-address (socket))
  45
  46 (defgeneric local-port (socket))
  47
  48 (defgeneric remote-name (socket))
  49
  50 (defgeneric remote-address (socket))
  51
  52 (defgeneric remote-port (socket))
  53
  54 (defgeneric get-socket-option (socket option-name))
  55
  56 (defgeneric set-socket-option (socket option-name &key &allow-other-keys))
  57
  58 (defclass stream-socket (socket) ()
  59   (:default-initargs :type :stream))
  60
  61 (defclass datagram-socket (socket) ()
  62   (:default-initargs :type :datagram))
  63
  64 (defgeneric disconnect (socket))
  65
  66 (defclass internet-socket (socket) ()
  67   (:default-initargs :family (if *ipv6* :ipv6 :ipv4)))
  68
  69 (defclass local-socket (socket) ()
  70   (:default-initargs :family :local))
  71
  72 (defclass active-socket (socket dual-channel-gray-stream) ())
  73
  74 (defgeneric connect (socket address &key &allow-other-keys))
  75
  76 (defgeneric socket-connected-p (socket))
  77
  78 (defgeneric shutdown (socket direction))
  79
  80 (defgeneric socket-send (buffer socket &key &allow-other-keys))
  81
  82 (defgeneric socket-receive (buffer socket &key &allow-other-keys))
  83
  84 (defclass passive-socket (socket)
  85   ((listening :initform nil :reader socket-listening-p :type boolean)
  86    (external-format :initarg :external-format :reader external-format-of
  87                     :type external-format)
  88    (active-class :initarg :active-class :reader active-class
  89                  :type symbol :allocation :class))
  90   (:default-initargs :external-format :default))
  91
  92 (defgeneric bind-address (socket address &key &allow-other-keys))
  93
  94 (defgeneric socket-listen (socket &key backlog &allow-other-keys))
  95
  96 (defgeneric accept-connection (passive-socket))
  97
  98 (defclass socket-stream-internet-active (active-socket stream-socket internet-socket) ())
  99
 100 (defclass socket-stream-internet-passive (passive-socket stream-socket internet-socket) ()
 101   (:default-initargs :active-class 'socket-stream-internet-active))
 102
 103 (defclass socket-stream-local-active (active-socket stream-socket local-socket) ())
 104
 105 (defclass socket-stream-local-passive (passive-socket stream-socket local-socket) ()
 106   (:default-initargs :active-class 'socket-stream-local-active))
 107
 108 (defclass socket-datagram-local-active (active-socket datagram-socket local-socket) ())
 109
 110 (defclass socket-datagram-internet-active (active-socket datagram-socket internet-socket) ())