lispdoc - results for socket 

(usocket:ip= ip1 ip2)
Undocumented
  
(usocket:ip/= ip1 ip2)
Undocumented
  
(usocket:socket object)
Undocumented
  
usocket:usocket
Type: The main socket class. Sockets should be closed using the `socket-close' method.
  
(usocket:unsupported feature context &key minimum)
Type: Signalled when the underlying implementation doesn't allow supporting the requested feature. When you see this error, go bug your vendor/implementation developer!
Structure: Signalled when the underlying implementation doesn't allow supporting the requested feature. When you see this error, go bug your vendor/implementation developer!
  
(usocket:unimplemented feature context)
Type: Signalled if a certain feature might be implemented, based on the features of the underlying implementation, but hasn't been implemented yet.
Structure: Signalled if a certain feature might be implemented, based on the features of the underlying implementation, but hasn't been implemented yet.
  
usocket:ns-error
Type: Parent error for all name resolution errors.
Structure: Parent error for all name resolution errors.
  
(usocket:add-waiter wait-list input)
Undocumented
  
(usocket:socket-send usocket buffer length &key host port)
Function: Send packets through a previously opend `usocket'.
  
usocket:*auto-port*
Variable: Port number to pass when an auto-assigned port number is wanted.
  
usocket:socket-error
Type: Parent error for all socket related errors
Structure: Parent error for all socket related errors
  
usocket:ns-condition
Type: Parent condition for all name resolution conditions.
Structure: Parent condition for all name resolution conditions.
  
(usocket:socket-close usocket)
Function: Close a previously opened `usocket'.
  
(usocket:remove-waiter wait-list input)
Undocumented
  
usocket:*remote-host*
Undocumented
  
usocket:*remote-port*
Undocumented
  
(usocket:socket-stream object)
Undocumented
  
(usocket:socket-accept socket &key element-type)
Function: Accepts a connection from `socket', returning a `stream-socket'. The stream associated with the socket returned has `element-type' when explicitly specified, or the element-type passed to `socket-listen' otherwise.
  
(usocket:socket-listen host port &key reuseaddress
 (reuse-address nil reuse-address-supplied-p) (backlog 5)
 (element-type 'character))
Function: Bind to interface `host' on `port'. `host' should be the representation of an ready-interface address. The implementation is not required to do an address lookup, making no guarantees that hostnames will be correctly resolved. If `*wildcard-host*' is passed for `host', the socket will be bound to all available interfaces for the IPv4 protocol in the system. `port' can be selected by the IP stack by passing `*auto-port*'. Returns an object of type `stream-server-usocket'. `reuse-address' and `backlog' are advisory parameters for setting socket options at creation time. `element-type' is the element type of the streams to be created by `socket-accept'. `reuseaddress' is supported for backward compatibility (but deprecated); when both `reuseaddress' and `reuse-address' have been specified, the latter takes precedence.
  
usocket:timeout-error
Undocumented
  
(usocket:socket-server host port function &optional arguments &key
 in-new-thread (protocol stream) (timeout 1)
 (max-buffer-size +max-datagram-packet-size+) element-type reuse-address
 multi-threading)
Undocumented
  
usocket:unknown-error
Type: Error raised when there's no other - more applicable - error available.
Structure: Error raised when there's no other - more applicable - error available.
  
usocket:shutdown-error
Undocumented
  
usocket:stream-usocket
Type: Stream socket class. ' Contrary to other sockets, these sockets may be closed either with the `socket-close' method or by closing the associated stream (which can be retrieved with the `socket-stream' accessor).
  
(usocket:socket-receive usocket buffer length &key
 (element-type '(unsigned-byte 8)))
Function: Receive packets from a previously opend `usocket'. Returns 4 values: (values buffer size host port)
  
usocket:socket-warning
Undocumented
  
(usocket:socket-connect host port &key (protocol stream)
 (element-type 'character) timeout deadline (nodelay t nodelay-specified)
 local-host local-port &aux
 (sockopt-tcp-nodelay-p (fboundp 'sockopt-tcp-nodelay)))
Function: Connect to `host' on `port'. `host' is assumed to be a string or an IP address represented in vector notation, such as #(192 168 1 1). `port' is assumed to be an integer. `element-type' specifies the element type to use when constructing the stream associated with the socket. The default is 'character. Returns a usocket object.
  
usocket:*wildcard-host*
Variable: Hostname to pass when all interfaces in the current system are to be bound.
  
usocket:socket-condition
Type: Parent condition for all socket related conditions.
Structure: Parent condition for all socket related conditions.
  
usocket:datagram-usocket
Type: UDP (inet-datagram) socket
  
(ql-ecl:inet-socket &rest args)
Undocumented
  
(ql-ccl:make-socket &rest args)
Undocumented
  
usocket:unknown-condition
Type: Condition raised when there's no other - more applicable - condition available.
Structure: Condition raised when there's no other - more applicable - condition available.
  
(qlb-abcl:make-socket &rest args)
Undocumented
  
(usocket:get-peer-name socket)
Function: Returns the IP address and port of the peer the socket is connected to as values.
  
(usocket:get-peer-port socket)
Function: Returns the IP port of the peer the socket to.
  
(ql-ecl:socket-connect &rest args)
Undocumented
  
usocket:interrupted-condition
Undocumented
  
(usocket:wait-for-input socket-or-sockets &key timeout ready-only)
Function: Waits for one or more streams to become ready for reading from the socket. When `timeout' (a non-negative real number) is specified, wait `timeout' seconds, or wait indefinitely when it isn't specified. A `timeout' value of 0 (zero) means polling. Returns two values: the first value is the list of streams which are readable (or in case of server streams acceptable). NIL may be returned for this value either when waiting timed out or when it was interrupted (EINTR). The second value is a real number indicating the time remaining within the timeout period or NIL if none. Without the READY-ONLY arg, WAIT-FOR-INPUT will return all sockets in the original list you passed it. This prevents a new list from being consed up. Some users of USOCKET were reluctant to use it if it wouldn't behave that way, expecting it to cost significant performance to do the associated garbage collection. Without the READY-ONLY arg, you need to check the socket STATE slot for the values documented in usocket.lisp in the usocket class.
  
(usocket:make-wait-list waiters)
Undocumented
  
(usocket:get-local-port socket)
Function: Returns the IP port of the socket. This function applies to both `stream-usocket' and `server-stream-usocket' type objects.
  
(usocket:get-local-name socket)
Function: Returns the IP address and port of the socket as values. This function applies to both `stream-usocket' and `server-stream-usocket' type objects.
  
(ql-allegro:make-socket &rest args)
Undocumented
  
usocket:host-down-error
Undocumented
  
(usocket:host-byte-order address)
Undocumented
  
(ql-clisp:socket-connect &rest args)
Undocumented
  
usocket:ns-unknown-error
Type: Error raised when there's no other - more applicable - error available.
Structure: Error raised when there's no other - more applicable - error available.
  
usocket:no-buffers-error
Undocumented
  
(usocket:get-peer-address socket)
Function: Returns the IP address of the peer the socket is connected to.
  
(usocket:get-local-address socket)
Function: Returns the IP address of the socket.
  
usocket:insufficient-implementation
Type: The ancestor of all errors usocket may generate because of insufficient support from the underlying implementation with respect to the arguments given to `function'. One call may signal several errors, if the caller allows processing to continue.
Structure: The ancestor of all errors usocket may generate because of insufficient support from the underlying implementation with respect to the arguments given to `function'. One call may signal several errors, if the caller allows processing to continue.
  
(usocket:with-server-socket (var server-socket) &body body)
Function: Bind `server-socket' to `var', ensuring socket destruction on exit. `body' is only evaluated when `var' is bound to a non-null value. The `body' is an implied progn form.
  
usocket:network-down-error
Undocumented
  
(usocket:remove-all-waiters wait-list)
Undocumented
  
(usocket:with-client-socket (socket-var stream-var &rest socket-connect-args)
 &body body)
Function: Bind the socket resulting from a call to `socket-connect' with the arguments `socket-connect-args' to `socket-var' and if `stream-var' is non-nil, bind the associated socket stream to it.
  
usocket:network-reset-error
Undocumented
  
usocket:invalid-socket-error
Undocumented
  
(usocket:with-socket-listener (socket-var &rest socket-listen-args) &body body)
Function: Bind the socket resulting from a call to `socket-listen' with arguments `socket-listen-args' to `socket-var'.
  
usocket:ns-unknown-condition
Type: Condition raised when there's no other - more applicable - condition available.
Structure: Condition raised when there's no other - more applicable - condition available.
  
usocket:stream-server-usocket
Type: Socket which listens for stream connections to be initiated from remote sockets.
  
(usocket:with-connected-socket (var socket) &body body)
Function: Bind `socket' to `var', ensuring socket destruction on exit. `body' is only evaluated when `var' is bound to a non-null value. The `body' is an implied progn form.
  
usocket:connection-reset-error
Undocumented
  
usocket:deadline-timeout-error
Undocumented
  
usocket:host-unreachable-error
Undocumented
  
(usocket:with-mapped-conditions (&optional socket) &body body)
Undocumented
  
usocket:invalid-argument-error
Undocumented
  
(ql-ecl:socket-make-stream &rest args)
Undocumented
  
usocket:connection-refused-error
Undocumented
  
usocket:connection-aborted-error
Undocumented
  
(usocket:ip-to-octet-buffer ip buffer &key (start 0))
Undocumented
  
(usocket:hbo-to-vector-quad integer)
Function: Host-byte-order integer to dotted-quad string conversion utility.
  
(usocket:hbo-to-dotted-quad integer)
Function: Host-byte-order integer to dotted-quad string conversion utility.
  
sb-bsd-sockets:inet-socket
Type: Class representing TCP and UDP sockets. Examples: (make-instance 'inet-socket :type :stream :protocol :tcp) (make-instance 'inet-socket :type :datagram :protocol :udp)
Example:
(defun host-make-listener-socket (address port)
  (let ((socket
         (make-instance
          'sb-bsd-sockets:inet-socket :type
          :stream :protocol :tcp)))
    (setf (sb-bsd-sockets:sockopt-reuse-address
           socket)
            t)
    (sb-bsd-sockets:socket-bind socket address
                                port)
    (sb-bsd-sockets:socket-listen socket 15)
    socket))
 
(qlb-abcl:get-socket-stream &rest args)
Undocumented
  
usocket:network-unreachable-error
Undocumented
  
(usocket:ip-from-octet-buffer buffer &key (start 0))
Undocumented
  
usocket:address-in-use-error
Undocumented
  
usocket:ns-no-recovery-error
Undocumented
  
(usocket:port-to-octet-buffer port buffer &key (start 0))
Undocumented
  
(ql-sbcl:socket-connect socket &rest address)
Function: Perform the connect(2) call to connect SOCKET to a remote PEER. No useful return value.
  
(usocket:port-from-octet-buffer buffer &key (start 0))
Undocumented
  
usocket:ns-try-again-condition
Undocumented
  
(usocket:integer-to-octet-buffer integer buffer octets &key (start 0))
Undocumented
  
(usocket:octet-buffer-to-integer buffer octets &key (start 0))
Undocumented
  
usocket:bad-file-descriptor-error
Undocumented
  
usocket:+max-datagram-packet-size+
Variable: The theoretical maximum amount of data in a UDP datagram. The IPv4 UDP packets have a 16-bit length constraint, and IP+UDP header has 28-byte. IP_MAXPACKET = 65535, /* netinet/ip.h */ sizeof(struct ip) = 20, /* netinet/ip.h */ sizeof(struct udphdr) = 8, /* netinet/udp.h */ 65535 - 20 - 8 = 65507 (But for UDP broadcast, the maximum message size is limited by the MTU size of the underlying link)
  
usocket:address-not-available-error
Undocumented
  
usocket:invalid-socket-stream-error
Undocumented
  
usocket:protocol-not-supported-error
Undocumented
  
usocket:operation-not-permitted-error
Undocumented
  
usocket:operation-not-supported-error
Undocumented
  
(ql-sbcl:host-ent-address host-ent)
Function: Returns some valid address for HOST-ENT.
  
usocket:ns-host-not-found-error
Undocumented
  
(ql-cmucl:connect-to-inet-socket &rest args)
Undocumented
  
(ql-sbcl:socket-make-stream socket &key input output element-type
 external-format buffering timeout (element-type 'character) (buffering full)
 (external-format default) auto-close (serve-events t))
Function: Find or create a STREAM that can be used for IO on SOCKET (which must be connected). Specify whether the stream is for INPUT, OUTPUT, or both (it is an error to specify neither). ELEMENT-TYPE and EXTERNAL-FORMAT are as per OPEN. TIMEOUT specifies a read timeout for the stream.
Example:
(defun listener-accept-stream (listener)
  (let ((socket
         (sb-bsd-sockets:socket-accept
          (http-listener-socket listener))))
    (sb-bsd-sockets:socket-make-stream socket
                                       :element-type
                                       'character
                                       :external-format
                                       :utf8
                                       :name
                                       "socket"
                                       :input t
                                       :output t
                                       :buffering
                                       :full)))
 
(usocket:dotted-quad-to-vector-quad string)
Undocumented
  
(usocket:vector-quad-to-dotted-quad vector)
Undocumented
  
(ql-sbcl:get-host-by-name host-name)
Function: Returns a HOST-ENT instance for HOST-NAME or signals a NAME-SERVICE-ERROR. HOST-NAME may also be an IP address in dotted quad notation or some other weird stuff - see gethostbyname(3) or getaddrinfo(3) for the details.
Example:
(defun my-fqdn ()
  (sb-bsd-sockets:host-ent-name
   (sb-bsd-sockets:get-host-by-name
    (machine-instance))))
 
usocket:socket-type-not-supported-error
Undocumented
  

By Bill Moorier