X-Git-Url: https://git.distorted.org.uk/u/mdw/putty/blobdiff_plain/d74d141c2daed084c8a62c5dc5b88e801b81ee5a..055817455466c8eb60392f30bb7c689763962e17:/network.h

diff --git a/network.h b/network.h
index e205b875..a97a6c47 100644
--- a/network.h
+++ b/network.h
@@ -13,27 +13,41 @@
 #ifndef PUTTY_NETWORK_H
 #define PUTTY_NETWORK_H
 
+#ifndef DONE_TYPEDEFS
+#define DONE_TYPEDEFS
+typedef struct config_tag Config;
+typedef struct backend_tag Backend;
+typedef struct terminal_tag Terminal;
+#endif
+
 typedef struct SockAddr_tag *SockAddr;
 /* pay attention to levels of indirection */
 typedef struct socket_function_table **Socket;
 typedef struct plug_function_table **Plug;
 
+#ifndef OSSOCKET_DEFINED
+typedef void *OSSocket;
+#endif
+
 struct socket_function_table {
     Plug(*plug) (Socket s, Plug p);
     /* use a different plug (return the old one) */
     /* if p is NULL, it doesn't change the plug */
     /* but it does return the one it's using */
     void (*close) (Socket s);
-    void (*write) (Socket s, char *data, int len);
-    void (*write_oob) (Socket s, char *data, int len);
+    int (*write) (Socket s, const char *data, int len);
+    int (*write_oob) (Socket s, const char *data, int len);
     void (*flush) (Socket s);
+    void (*set_private_ptr) (Socket s, void *ptr);
+    void *(*get_private_ptr) (Socket s);
+    void (*set_frozen) (Socket s, int is_frozen);
     /* ignored by tcp, but vital for ssl */
-    char *(*socket_error) (Socket s);
+    const char *(*socket_error) (Socket s);
 };
 
 struct plug_function_table {
     int (*closing)
-     (Plug p, char *error_msg, int error_code, int calling_back);
+     (Plug p, const char *error_msg, int error_code, int calling_back);
     /* error_msg is NULL iff it is not an error (ie it closed normally) */
     /* calling_back != 0 iff there is a Plug function */
     /* currently running (would cure the fixme in try_send()) */
@@ -48,24 +62,59 @@ struct plug_function_table {
      *  - urgent==2. `data' points to `len' bytes of data,
      *    the first of which was the one at the Urgent mark.
      */
-    int (*accepting)(Plug p, struct sockaddr *addr, void *sock);
+    void (*sent) (Plug p, int bufsize);
+    /*
+     * The `sent' function is called when the pending send backlog
+     * on a socket is cleared or partially cleared. The new backlog
+     * size is passed in the `bufsize' parameter.
+     */
+    int (*accepting)(Plug p, OSSocket sock);
     /*
      * returns 0 if the host at address addr is a valid host for connecting or error
      */
 };
 
+/* proxy indirection layer */
+/* NB, control of 'addr' is passed via new_connection, which takes
+ * responsibility for freeing it */
+Socket new_connection(SockAddr addr, char *hostname,
+		      int port, int privport,
+		      int oobinline, int nodelay, int keepalive,
+		      Plug plug, const Config *cfg);
+Socket new_listener(char *srcaddr, int port, Plug plug, int local_host_only,
+		    const Config *cfg, int addressfamily);
+SockAddr name_lookup(char *host, int port, char **canonicalname,
+		     const Config *cfg, int addressfamily);
+
+/* platform-dependent callback from new_connection() */
+/* (same caveat about addr as new_connection()) */
+Socket platform_new_connection(SockAddr addr, char *hostname,
+			       int port, int privport,
+			       int oobinline, int nodelay, int keepalive,
+			       Plug plug, const Config *cfg);
+
+/* socket functions */
 
 void sk_init(void);		       /* called once at program startup */
-
-SockAddr sk_namelookup(char *host, char **canonicalname);
+void sk_cleanup(void);		       /* called just before program exit */
+
+SockAddr sk_namelookup(const char *host, char **canonicalname, int address_family);
+SockAddr sk_nonamelookup(const char *host);
+void sk_getaddr(SockAddr addr, char *buf, int buflen);
+int sk_hostname_is_local(char *name);
+int sk_address_is_local(SockAddr addr);
+int sk_addrtype(SockAddr addr);
+void sk_addrcopy(SockAddr addr, char *buf);
 void sk_addr_free(SockAddr addr);
 
+/* NB, control of 'addr' is passed via sk_new, which takes responsibility
+ * for freeing it, as for new_connection() */
 Socket sk_new(SockAddr addr, int port, int privport, int oobinline,
-	      Plug p);
+	      int nodelay, int keepalive, Plug p);
 
-Socket sk_newlistenner(int port, Plug plug);
+Socket sk_newlistener(char *srcaddr, int port, Plug plug, int local_host_only, int address_family);
 
-Socket sk_register(void *sock, Plug plug);
+Socket sk_register(OSSocket sock, Plug plug);
 
 #define sk_plug(s,p) (((*s)->plug) (s, p))
 #define sk_close(s) (((*s)->close) (s))
@@ -76,7 +125,8 @@ Socket sk_register(void *sock, Plug plug);
 #ifdef DEFINE_PLUG_METHOD_MACROS
 #define plug_closing(p,msg,code,callback) (((*p)->closing) (p, msg, code, callback))
 #define plug_receive(p,urgent,buf,len) (((*p)->receive) (p, urgent, buf, len))
-#define plug_accepting(p, addr, sock) (((*p)->accepting)(p, addr, sock))
+#define plug_sent(p,bufsize) (((*p)->sent) (p, bufsize))
+#define plug_accepting(p, sock) (((*p)->accepting)(p, sock))
 #endif
 
 /*
@@ -86,25 +136,50 @@ Socket sk_register(void *sock, Plug plug);
  * This is perhaps unnecessary now that we have the notion of a plug,
  * but there is some existing code that uses it, so it stays.
  */
-void sk_set_private_ptr(Socket s, void *ptr);
-void *sk_get_private_ptr(Socket s);
+#define sk_set_private_ptr(s, ptr) (((*s)->set_private_ptr) (s, ptr))
+#define sk_get_private_ptr(s) (((*s)->get_private_ptr) (s))
 
 /*
  * Special error values are returned from sk_namelookup and sk_new
  * if there's a problem. These functions extract an error message,
  * or return NULL if there's no problem.
  */
-char *sk_addr_error(SockAddr addr);
+const char *sk_addr_error(SockAddr addr);
 #define sk_socket_error(s) (((*s)->socket_error) (s))
 
 /*
  * Set the `frozen' flag on a socket. A frozen socket is one in
- * which all sends are buffered and receives are ignored. This is
- * so that (for example) a new port-forwarding can sit in limbo
- * until its associated SSH channel is ready, and then pending data
- * can be sent on.
+ * which all READABLE notifications are ignored, so that data is
+ * not accepted from the peer until the socket is unfrozen. This
+ * exists for two purposes:
+ * 
+ *  - Port forwarding: when a local listening port receives a
+ *    connection, we do not want to receive data from the new
+ *    socket until we have somewhere to send it. Hence, we freeze
+ *    the socket until its associated SSH channel is ready; then we
+ *    unfreeze it and pending data is delivered.
+ * 
+ *  - Socket buffering: if an SSH channel (or the whole connection)
+ *    backs up or presents a zero window, we must freeze the
+ *    associated local socket in order to avoid unbounded buffer
+ *    growth.
+ */
+#define sk_set_frozen(s, is_frozen) (((*s)->set_frozen) (s, is_frozen))
+
+/*
+ * Call this after an operation that might have tried to send on a
+ * socket, to clean up any pending network errors.
+ */
+void net_pending_errors(void);
+
+/*
+ * Simple wrapper on getservbyname(), needed by ssh.c. Returns the
+ * port number, in host byte order (suitable for printf and so on).
+ * Returns 0 on failure. Any platform not supporting getservbyname
+ * can just return 0 - this function is not required to handle
+ * numeric port specifications.
  */
-void sk_set_frozen(Socket sock, int is_frozen);
+int net_service_lookup(char *service);
 
 /********** SSL stuff **********/