"

 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.

"

NonPositionableExternalStream subclass:#Socket

	instanceVariableNames:'domain socketType protocol port serviceName peerName'

	classVariableNames:''

	poolDictionaries:''

	category:'Streams-External'

!

!Socket primitiveDefinitions!

%{

/* #define NO_BUFFER */

#include <stdio.h>

#include <errno.h>

#ifdef LINUX

/* use inline string macros ... */

# define __STRINGDEFS__

# include <linuxIntern.h>

/* kludge to avoid some redefines ... */

# define _ARPA_NAMESER_H

# define _NETINET_TCP_H

#endif

#ifndef transputer

# include <fcntl.h>

# include <sys/types.h>

# if defined(IRIS) && !defined(IRIX5)

   /* no socket.h on 4.0.5h ?!?!? */

#  define AF_UNIX 1

#  define AF_INET 2

#  define SOCK_STREAM 1

#  define SOCK_DGRAM  2

#  define SOCK_RAW    3

# else

#  include <sys/socket.h>

# endif

# ifdef NEXT3

#  include <netinet/in_systm.h>

# endif

# include <netdb.h>

# include <netinet/in.h>

# if ! (defined(SYSV3) && defined(mc88k))

#  include <netinet/tcp.h>

# endif

#endif

/*

 * just in case those PF_xxx's are undefined

 */

#ifdef AF_UNIX

# ifndef PF_UNIX

#  define PF_UNIX AF_UNIX

# endif

#endif

#ifdef AF_INET

# ifndef PF_INET

#  define PF_INET AF_INET

# endif

#endif

#ifdef AF_DECnet

# ifndef PF_DECnet

#  define PF_DECnet AF_DECnet

# endif

#endif

#ifdef AF_APPLETALK

# ifndef PF_APPLETALK

#  define PF_APPLETALK AF_APPLETALK

# endif

#endif

#ifdef AF_X25

# ifndef PF_X25

#  define PF_X25 AF_X25

# endif

#endif

#ifdef AF_NS

# ifndef PF_NS

#  define PF_NS AF_NS

# endif

#endif

#ifdef AF_SNA

# ifndef PF_SNA

#  define PF_SNA AF_SNA

# endif

#endif

#ifdef AF_RAW

# ifndef PF_RAW

#  define PF_RAW AF_RAW

# endif

#endif

#ifdef AF_UNIX

# include <sys/un.h>

#endif

/*

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

 */

#ifndef errno

 extern errno;

#endif

static int __debugging__ = 0;

#ifdef DEBUG

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

#else

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

#endif

%}

! !

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 (unix-)sockets for interprocess communication.

    The message protocol is preliminary, until someone tells me how

    other smalltalk's socket interfaces look like.

    Also, currently there is almost no support for other than IP 

    sockets - this will be added in the future.

    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

    still provided. 

    This will vanish; use the family:type: or newTCPxxx and newUDPxxx interface,

    together with the bind/listen and accept calls,

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

    ST/X does not use IPSocketAddress, UDSocketAddress erc; all addressing

    is done by passing appropriate string- or byteArray objects containing

    the addresses. This may change, too.

    TODO: cleanup historic leftovers, implement other than inet domain stuff.

    [author:]

        Claus Gittinger

"

!

examples

"

    example (get help info from an nntp server):

                                                                        [exBegin]

        |sock host|

        host := OperatingSystem getEnvironment:'NNTPSERVER'.

        sock := Socket newTCPclientToHost:host port:'nntp'.

        Transcript showCR:sock nextLine.

        sock buffered:false.

        sock nextPutAll:'HELP'; cr.

        [:exit |

            |line|

            line := sock nextLine.

            line = '.' ifTrue:[exit value:nil].

            Transcript showCR:line.

        ] loopWithExit.

        sock close

                                                                        [exEnd]

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

                                                                        [exBegin]

        |sock host entry|

        host := OperatingSystem getHostName.

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

        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 host|

        host := OperatingSystem getHostName.

        sock := Socket newTCPclientToHost:host 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:'LIST'; cr.

        Transcript showCR:sock nextLine.

        sock close.

        'dont know enough of the ftp protocol to continue here ...'

                                                                        [exEnd]

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

                                                                        [exBegin]

        |sock port|

        sock := Socket newUDP.

        port := Socket portOfService:'snmp'.

        sock connectTo:(OperatingSystem getHostName) port:port.

        sock buffered:false.

        Transcript showCR:'got it'.

        sock close.

                                                                        [exEnd]

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

        |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.

            ]

        ]

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

        |sock|

        sock := Socket newTCPclientToHost:(OperatingSystem getHostName) 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

        ]

    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

        |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

        ]

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

                                                                        [exBegin]

        |myName myAddress list top hosts walkProcess port|

        myName := OperatingSystem getHostName.

        myAddress := Socket ipAddressOfHost:myName.

        port := Socket portOfService:'echo'.

        port isNil ifTrue:[

            self error:'dont know echo port'.

            ^ self

        ].

        top := StandardSystemView new.

        top label:'PING net walk'.

        list := ScrollableView for:ListView in:top.

        list origin:0.0@0.0 corner:1.0@1.0.

        top openAndWait.

        walkProcess := [

            |l low hi direction tryHostID dottedName hostName conn addr|

            l := SortedCollection new.

            ' only works with type C-net

              the code below could simply do 1 to:254 do:[:hostID }

              but, to probe likely hosts earlier, the probing is done

              ping-pong like around my ip-address (assuming, that other machines

              have numbers around my own)'.

            low := hi := (myAddress at:4).

            direction := 1.

            [low > 0 or:[hi < 255]] whileTrue:[

                direction > 0 ifTrue:[

                    hi := hi + 1.

                    tryHostID := hi.

                    direction := -1.

                ] ifFalse:[

                    low := low - 1.

                    tryHostID := low.

                    direction := 1.

                ].

                (tryHostID between:1 and:254) ifTrue:[

                    dottedName := (myAddress at:1) printString

                                  , '.' , (myAddress at:2) printString

                                  , '.' , (myAddress at:3) printString

                                  , '.' , tryHostID printString.

                    top label:'PING net walk - trying ' , dottedName.

                    top windowGroup withCursor:Cursor wait do:[

                        conn := Socket newTCPclientToHost:dottedName port:port withTimeout:1000.

                        conn notNil ifTrue:[

                            addr := Socket ipAddressOfHost:dottedName.

                            hostName := Socket hostWithIpAddress:addr.

                            hostName isNil ifTrue:[

                                hostName :='?'

                            ].

                            l add:(dottedName paddedTo:15 with:Character space) 

                                   , ' ' 

                                   , (hostName paddedTo:15 with:Character space)

                                   , ' up & reachable'.

                            list list:l.

                            conn close.

                        ]

                    ].

                ].

            ].

            top label:'PING reachable hosts'.

        ] forkAt:(Processor userBackgroundPriority).

        walkProcess name:'ping net walker'.

                                                                        [exEnd]

"

! !

family:domainSymbol type:typeSymbol

    "create a socket for domain and type - ST80 simply uses a different name.

     Domain must be one of the symbols: #inet, #unix, #ns, #appletalk or #ns;

     Type must be #stream, #datagram or #raw

     XXX: currently only the #inet domain is supported"

    ^ self domain:domainSymbol type:typeSymbol

    "

     Socket family:#inet type:#stream

     Socket family:#inet type:#datagram

     Socket family:#unix type:#stream

    "

! !

sockStream

    "return the type code for stream sockets"

    ^ #stream

! !

brokenConnectionSignal

    "return the signal used to tell broken connections.

     Since in unix, this is the same as the broken pipe signal,

     return that one.

     (for other Operatingsystems, this may change ..)"

    ^ PipeStream brokenPipeSignal

! !

debug:aBoolean

    "turn on/off internal debugprints.

     This method is for ST/X debugging only and

     may  be removed in later versions"

%{  /* NOCONTEXT */

    __debugging__ = (aBoolean == true);

%}

    "

     Socket debug:true

     Socket debug:false

    "