Back to index

lightning-sunbird  0.9+nobinonly
tcp.h
Go to the documentation of this file.
00001 /* ***** BEGIN LICENSE BLOCK *****
00002  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00003  *
00004  * The contents of this file are subject to the Mozilla Public License Version
00005  * 1.1 (the "License"); you may not use this file except in compliance with
00006  * the License. You may obtain a copy of the License at
00007  * http://www.mozilla.org/MPL/
00008  *
00009  * Software distributed under the License is distributed on an "AS IS" basis,
00010  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00011  * for the specific language governing rights and limitations under the
00012  * License.
00013  *
00014  * The Original Code is Mozilla Communicator client code, released
00015  * March 31, 1998.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998-1999
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either the GNU General Public License Version 2 or later (the "GPL"), or
00026  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 /*
00038  * tcp.h  interface to MCS's TCP routines
00039  */
00040  
00041 #include <Dialogs.h>
00042 #include <OpenTransport.h>
00043 #include <OpenTptInternet.h>
00044 
00045 //#include "MacTCPCommonTypes.h"
00046 //#include "AddressXlation.h"
00047 //#include "TCPPB.h"
00048 //#include "GetMyIPAddr.h"
00049 #include <utime.h>   /* for the UNIX-y struct timeval */
00050 
00051 //#include <MacTCP.h>
00052 
00053 #ifndef TCP_BUFSIZ
00054 #define TCP_BUFSIZ   8192
00055 #endif /* TCP_BUFSIZ */
00056 
00057 typedef struct tcpstream {
00058        EndpointRef                 tcps_ep;                    /* OpenTransport end point */
00059        short                       tcps_data;                  /* count of packets on read queue */
00060        short                       drefnum;                    /* driver ref num, for convenience */
00061        Boolean                            tcps_connected;             /* true if connection was made */
00062        Boolean                            tcps_terminated;     /* true if connection no longer exists */
00063        InetHost                    tcps_remoteaddr;     /* Address of our peer */
00064        InetPort                    tcps_remoteport;     /* Port number of our peer */
00065        unsigned char        *tcps_buffer;        /* buffer given over to system to use */
00066 } tcpstream, *tcpstreamptr;
00067 
00068 #define TCP_IS_TERMINATED( tsp )          (tsp)->tcps_terminated
00069 
00070 /*
00071  * function prototypes
00072  */
00073 OSStatus      tcp_init(void);
00074 Boolean              tcp_have_opentransport( void );
00075 tcpstream     *tcpopen( unsigned char * buf, long buflen );
00076 InetPort      tcpconnect( tcpstream *s, InetHost addr, InetPort port );
00077 short         tcpclose( tcpstream *s );
00078 long          tcpread(  tcpstream *s, UInt8 timeout, unsigned char * rbuf,
00079                             unsigned short rbuflen, DialogPtr dlp );
00080 long          tcpwrite( tcpstream *s, unsigned char * wbuf, unsigned short wbuflen );
00081 short         tcpselect( tcpstream *s, struct timeval * timeout );
00082 short         tcpreadready( tcpstream *tsp );
00083 short         tcpwriteready( tcpstream *tsp );
00084 short         tcpgetpeername( tcpstream * tsp, InetHost *addrp, InetPort *portp );
00085 
00086 short         gethostinfobyname( char *host, InetHostInfo *hip );
00087 short         gethostinfobyaddr(InetHost addr, InetHostInfo *hip );
00088 short         ipaddr2str( InetHost ipaddr, char *addrstr );