"

 COPYRIGHT (c) 1992 by Claus Gittinger

	      All Rights Reserved

 This software is furnished under a license and may be used

 only in accordance with the terms of that license and with the

 inclusion of the above copyright notice.   This software may not

 be provided or otherwise made available to, or used by, any

 other person.  No title to or ownership of the software is

 hereby transferred.

"

"{ Package: 'stx:libbasic2' }"

"{ NameSpace: Smalltalk }"

NonPositionableExternalStream subclass:#Socket

	instanceVariableNames:'domain socketType protocol port peer peerName listening'

	classVariableNames:''

	poolDictionaries:''

	category:'Streams-External'

!

!Socket primitiveDefinitions!

%{

/* #define DGRAM_DEBUG /* */

#ifdef __MINGW__

# include <stdio.h>

#endif

#include "stxOSDefs.h"

#ifdef __win32__

//#define DEBUG 1

/* this is to catch uses of those - there should be none */

# undef __BEGIN_INTERRUPTABLE__

# undef __END_INTERRUPTABLE__

# ifdef __TCC__

#  define __BEGIN_INTERRUPTABLE__ xxxx

#  define __END_INTERRUPTABLE__ yyyy

# else

#  define __BEGIN_INTERRUPTABLE__ ..

#  define __END_INTERRUPTABLE__ ..

# endif

# define WRAP_STDIO

// The default is linger until all data is sent in background

// so the close on the socket is non-blocking

// linger.onoff=off linger.time= *irrelevant*

//# define SET_LINGER_WHEN_CREATING_SOCKET

# ifdef __xxMINGW__

extern HANDLE _get_osfhandle();

# endif

# if defined(__BORLANDC__)

// not defined in borland headers

typedef unsigned int socklen_t;

# endif

# if 0 && (defined( __BORLANDC__ ) || defined( __MINGW__ ))

#  define SOCKET_FROM_FD(fd)               (SOCKET)(_get_osfhandle(fd))

# else

#  define SOCKET_FROM_FD(fd)               (SOCKET)(fd)

# endif

#else /* not __win32__ */

# define SOCKET_FROM_FD(fd)   (fd)

# define closesocket(sock)    close(sock)

# define SOCKET               int

#endif /* ! __win32__ */

#define SOCKET_FROM_FILE(f)             (SOCKET_FROM_FD(fileno(f)))

#define SOCKET_FROM_FILE_OBJECT(f)      (__INST(handleType) == @symbol(socketHandle) ? SOCKET_FROM_FD(__FILEVal(f)) : SOCKET_FROM_FILE(__FILEVal(f)))

#ifndef __MINGW__

# include <stdio.h>

#endif

#include <errno.h>

#ifdef WANT__TCP_DOT_H

# include <netinet/tcp.h>

#endif

#ifdef WANT__NETDB_DOT_H

# include <netdb.h>

#endif

#if defined(TRY_AGAIN) || defined(HOST_NOT_FOUND)

# define USE_H_ERRNO

#endif

/*

 * on some systems errno is a macro ... check for it here

 */

#ifndef errno

 extern errno;

#endif

#ifdef USE_H_ERRNO

# ifndef h_errno

 extern h_errno;

# endif

#endif

#ifdef DEBUG

# define DBGPRINTF(x)    { if (__debugging__) console_printf x; }

# define DBGFPRINTF(x)   { if (__debugging__) console_fprintf x; }

#else

# define DBGPRINTF(x)    /* as nothing */

# define DBGFPRINTF(x)   /* as nothing */

#endif

#ifndef TRUE

# define TRUE   1

#endif

#ifndef FALSE

# define FALSE  0

#endif

#ifndef __win32__

typedef int BOOL;

#endif

#ifdef __win32__

# undef stdout

# undef stderr

# define stdout __win32_stdout()

# define stderr __win32_stderr()

#endif

%}

! !

!Socket primitiveVariables!

%{

static int __debugging__ = 0;

%}

! !

!Socket primitiveFunctions!

%{

static int

setupBufferParameters(OBJ aDataBuffer, OBJ startIndex, char **p_extPtr, INT *p_offs, size_t *p_objSize)

{

	char *extPtr = 0;

	int sIdx = 0, objSize = 0, offs = 0;

	sIdx = 0;

	if (__isSmallInteger(startIndex)) {

	    sIdx = __intVal(startIndex) - 1;

	}

	if (__isExternalBytesLike(aDataBuffer)) {

	    OBJ sz;

	    extPtr = (char *)(__externalBytesAddress(aDataBuffer));

	    sz = __externalBytesSize(aDataBuffer);

	    if (__isSmallInteger(sz)) {

		objSize = __intVal(sz);

	    } else {

		objSize = 0; /* unknown */

	    }

	    offs = sIdx;

	} else {

	    OBJ oClass;

	    int nInstVars, nInstBytes;

	    extPtr = (char *)0;

	    oClass = __Class(aDataBuffer);

	    switch (__intVal(__ClassInstPtr(oClass)->c_flags) & ARRAYMASK) {

		case BYTEARRAY:

		    offs = sIdx;

		    break;

		case WORDARRAY:

		case SWORDARRAY:

		    offs = sIdx * 2;

		    break;

		case LONGARRAY:

		case SLONGARRAY:

		    offs = sIdx * 4;

		    break;

		case LONGLONGARRAY:

		case SLONGLONGARRAY:

		    offs = sIdx * 8;

# ifdef __NEED_LONGLONG_ALIGN

		    offs += 4;

# endif

		    break;

		case FLOATARRAY:

		    offs = sIdx * sizeof(float);

		    break;

		case DOUBLEARRAY:

		    offs = sIdx * sizeof(double);

# ifdef __NEED_DOUBLE_ALIGN

		    offs += 4;

# endif

		    break;

		default:

		    *p_objSize = -1;

		    return 0;

	    }

	    nInstVars = __intVal(__ClassInstPtr(oClass)->c_ninstvars);

	    nInstBytes = OHDR_SIZE + nInstVars * sizeof(OBJ);

	    offs = offs + nInstBytes;

	    objSize = __Size(aDataBuffer) - offs;

	}

	*p_extPtr = extPtr;

	*p_objSize = objSize;

	*p_offs = offs;

	return 1;

}

%}

! !

!Socket class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1992 by Claus Gittinger

	      All Rights Reserved

 This software is furnished under a license and may be used

 only in accordance with the terms of that license and with the

 inclusion of the above copyright notice.   This software may not

 be provided or otherwise made available to, or used by, any

 other person.  No title to or ownership of the software is

 hereby transferred.

"

!

documentation

"

    This class provides access to sockets for interprocess communication.

    Currently, only IP and UNIX domain sockets are really fully

    tested and supported.

    Code for appletalk is included, but was never tested ...

    More may be added in the future.

    (the code is prepared for things like SNA or decNet;

     however, right now, this code is empty and needs a little work.

     Implementing those is pretty straightforward, once the address

     data structures are known.)

    Due to historic reasons (I started this class, before I got hold of some

    code using ST-80 Sockets i.e. RemoteInvocation), there is some old interface

    which is still supported.

    This may vanish; use the #family:type: or #newTCPxxx and #newUDPxxx interfaces,

    together with the bind/listen and accept calls,

    which are meant to be compatible to ST-80's UnixSocketAccessor interface.

    TODO: cleanup historic leftovers,

          change to raise more signals on errors.

    [author:]

        Claus Gittinger

"

!

examples

"

    example (get help info from an nntp server):

                                                                        [exBegin]

        |sock|

        sock := Socket newTCPclientToHost:'smtp.exept.de' port:'smtp'.

        sock isNil ifTrue:[

            self warn:'no smtp daemon is running'.

            ^ self

        ].

        Transcript showCR:sock nextLine.

        sock nextPutAll:'HELO STX socket test'; cr.

        Transcript showCR:sock nextLine.

        sock close

                                                                        [exEnd]

    example (connect to finger daemon, get users entry):

                                                                        [exBegin]

        |sock entry|

        sock := Socket newTCPclientToHost:'localhost' port:'finger'.

        sock isNil ifTrue:[

            self warn:'no finger daemon is running'.

            ^ self

        ].

        sock useCRLF:true.

        sock buffered:false.

        sock isNil ifTrue:[

            Transcript showCR:'cannot connect to local finger daemon'

        ] ifFalse:[

            sock nextPutAll:(OperatingSystem getLoginName).

            sock cr.

            entry := sock nextLine.

            Transcript showCR:entry.

            sock close

        ]

                                                                        [exEnd]

    example (connect to an ftp server):

                                                                        [exBegin]

        |sock|

        sock := Socket newTCPclientToHost:'www.exept.de' port:'ftp'.

        sock buffered:false.

        Transcript showCR:sock nextLine.

        sock nextPutAll:('USER ' , 'anonymous'); cr.

        Transcript showCR:sock nextLine.

        sock nextPutAll:('PASS ' , 'fooBar'); cr.

        Transcript showCR:sock nextLine.

        sock nextPutAll:'HELP'; cr.

        [

            |line|

            line := sock nextLine.

            Transcript showCR:line.

            (line at:4) = $-

        ] whileTrue.

        sock close.

        'don't know enough of the ftp protocol to continue here ...'

                                                                        [exEnd]

    example (connect to an snmp server [UDP]):

    Note: this is not a real connection, only the destination address is

          being fixed.

                                                                        [exBegin]

        |sock port|

        sock := Socket newUDP.

        port := Socket portOfService:'snmp'.

        sock connectTo:'localhost' port:port.

        sock buffered:false.

        Transcript showCR:'got it'.

        sock close.

                                                                        [exEnd]

    example (await connection from a client and read some data):

                                                                        [exBegin]

        |connectSock sock|

        connectSock := Socket newTCPserverAtPort:9998.

        connectSock isNil ifTrue:[

            Transcript showCR:'socket setup failed.'.

        ] ifFalse:[

            Transcript showCR:'listen ..'.

            (connectSock listenFor:5) ifFalse:[

                Transcript showCR:'listen failed.'.

            ] ifTrue:[

                Transcript showCR:'wait'.

                connectSock readWait.

                Transcript showCR:'accept'.

                sock := connectSock accept.

                sock isNil ifTrue:[

                    Transcript showCR:'accept failed.'.

                ] ifFalse:[

                    sock buffered:false.

                    Transcript showCR:'server: got it'.

                    'can now do transfer via sock'.

                    Transcript showCR:'read'.

                    Transcript showCR:('got: ' , sock nextLine).

                    Transcript showCR:'close'.

                    sock close

                ].

                connectSock close.

            ]

        ]

                                                                        [exEnd]

    example (connect to above server and send some data):

                                                                        [exBegin]

        |sock|

        sock := Socket newTCPclientToHost:'localhost' port:9998.

        sock isNil ifTrue:[

            Transcript showCR:'nope'

        ] ifFalse:[

            sock buffered:false.

            Transcript showCR:'client: got it'.

            'can now do transfer via sock'.

            Transcript showCR:'sending <hello>'.

            sock nextPutLine:'hello'.

            sock close

        ]

                                                                        [exEnd]

    example: UNIX domain socket (await connection from a client and read some data):

        |connectSock sock|

        '/tmp/ud_socket' asFilename remove.

        connectSock := Socket newUNIXserverAt:'/tmp/ud_socket'.

        connectSock isNil ifTrue:[

            Transcript showCR:'socket setup failed.'.

        ] ifFalse:[

            Transcript showCR:'listen ..'.

            (connectSock listenFor:5) ifFalse:[

                Transcript showCR:'listen failed.'.

            ] ifTrue:[

                Transcript showCR:'wait'.

                connectSock buffered:false.

                connectSock readWait.

                Transcript showCR:'accept'.

                sock := connectSock accept.

                sock isNil ifTrue:[

                    Transcript showCR:'accept failed.'.

                ] ifFalse:[

                    sock buffered:false.

                    Transcript showCR:'server: got it'.

                    'can now do transfer via sock'.

                    Transcript showCR:'read'.

                    Transcript showCR:('got: ' , sock nextLine).

                    Transcript showCR:'close'.

                    sock close

                ].

                connectSock close.

            ]

        ]

    example (connect to above server and send some data;

             Notice, this fails, if above server code is executed in the same ST/X image

                     (at least on LINUX), since the OS does not correctly handle

                     a connect from within an interrupted accept system call

                     On SGI's SVR4, this works ok

                                                                        [exBegin]

        |sock|

        sock := Socket newUNIXclientTo:'/tmp/ud_socket'.

        sock isNil ifTrue:[

            Transcript showCR:'nope'

        ] ifFalse:[

            sock buffered:false.

            Transcript showCR:'client: got it'.

            'can now do transfer via sock'.

            Transcript showCR:'sending <hello>'.

            sock nextPutLine:'hello'.

            sock close

        ]

                                                                        [exEnd]

    example (UDP await packet from a client and read some data):

                                                                        [exBegin]

        |udpSock sock addr n dataBuffer|

        udpSock := Socket newUDPserverAtPort:9999.

        udpSock isNil ifTrue:[

            Transcript showCR:'socket setup failed.'.

        ] ifFalse:[

            Transcript showCR:'wait'.

            udpSock readWait.

            addr := IPSocketAddress new.

            dataBuffer := ByteArray new:1000.

            n := udpSock receiveFrom:addr buffer:dataBuffer start:1 for:dataBuffer size.

            n > 0 ifTrue:[

                Transcript showCR:('got: ' , n printString , 'bytes  from ' , addr printString).

                Transcript showCR:('data: ' , (dataBuffer copyTo:n) printString).

            ] ifFalse:[

                Transcript showCR:'read failed'.

            ].

            Transcript showCR:'close'.

            udpSock close

        ]

                                                                        [exEnd]

    example (connect to above UDP server and send some data;

                                                                        [exBegin]

        |sock|

        sock := Socket newUDP.

        sock isNil ifTrue:[

            Transcript showCR:'nope'

        ] ifFalse:[

            sock sendTo:(IPSocketAddress new hostName:'localhost' port:9999) buffer:'hello world'.

            sock close

        ]

                                                                        [exEnd]

    example: pingWalk (try to ping hosts on the local network)

    Note: it dosen't use ICMP ping, but tries to reache the echo service,