2 * WINGs WMConnection function library
4 * Copyright (c) 1999-2000 Dan Pascu
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24 * - decide if we want to support connections with external sockets, else
25 * clean up the structure of the unneeded members.
30 #include "../src/config.h"
39 #include <sys/socket.h>
40 #include <netinet/in.h>
41 #include <arpa/inet.h>
45 #include <sys/signal.h>
51 /* Some older systems does not define this (linux libc5, maybe others too) */
63 # define INADDR_NONE -1
66 /* Stuff for setting the sockets into non-blocking mode. */
67 /*#ifdef __POSIX_SOURCE
68 # define NONBLOCK_OPT O_NONBLOCK
70 # define NONBLOCK_OPT FNDELAY
73 #define NONBLOCK_OPT O_NONBLOCK
75 #define NETBUF_SIZE 4096
77 #define DEF_TIMEOUT 600 /* 600 seconds == 10 minutes */
82 static Bool SigInitialized
= False
;
86 typedef struct TimeoutData
{
92 typedef struct W_Connection
{
93 int sock
; /* the socket we speak through */
96 WMHandlerID
*read
; /* the input read handler */
97 WMHandlerID
*write
; /* the input write handler */
98 WMHandlerID
*exception
; /* the input exception handler */
101 ConnectionDelegate
*delegate
; /* client delegates */
102 void *clientData
; /* client data */
103 unsigned int uflags
; /* flags for the client */
108 TimeoutData sendTimeout
;
110 WMConnectionState state
;
126 clearOutputQueue(WMConnection
*cPtr
) /*FOLD00*/
132 for (i
=0; i
<WMGetBagItemCount(cPtr
->outputQueue
); i
++)
133 WMReleaseData(WMGetFromBag(cPtr
->outputQueue
, i
));
135 WMEmptyBag(cPtr
->outputQueue
);
140 sendTimeout(void *cdata
) /*FOLD00*/
142 WMConnection
*cPtr
= (WMConnection
*) cdata
;
143 TimeoutData
*tPtr
= &cPtr
->sendTimeout
;
145 tPtr
->handler
= NULL
;
146 if (cPtr
->handler
.write
) {
147 WMDeleteInputHandler(cPtr
->handler
.write
);
148 cPtr
->handler
.write
= NULL
;
150 if (WMGetBagItemCount(cPtr
->outputQueue
)>0) {
151 clearOutputQueue(cPtr
);
152 if (cPtr
->delegate
&& cPtr
->delegate
->didTimeout
)
153 (*cPtr
->delegate
->didTimeout
)(cPtr
->delegate
, cPtr
);
159 inputHandler(int fd
, int mask
, void *clientData
) /*FOLD00*/
161 WMConnection
*cPtr
= (WMConnection
*)clientData
;
163 if (cPtr
->state
==WCClosed
|| cPtr
->state
==WCDied
)
166 if ((mask
& WIWriteMask
)) {
167 if (cPtr
->state
== WCInProgress
) {
170 int len
= sizeof(result
);
172 if (getsockopt(cPtr
->sock
, SOL_SOCKET
, SO_ERROR
,
173 (void*)&result
, &len
) == 0 && result
!= 0) {
174 cPtr
->state
= WCFailed
;
175 WCErrorCode
= result
;
177 /* should call wsyserrorwithcode(result, ...) here? */
179 cPtr
->state
= WCConnected
;
183 if (cPtr
->handler
.write
) {
184 WMDeleteInputHandler(cPtr
->handler
.write
);
185 cPtr
->handler
.write
= NULL
;
188 if (cPtr
->delegate
&& cPtr
->delegate
->didInitialize
)
189 (*cPtr
->delegate
->didInitialize
)(cPtr
->delegate
, cPtr
);
191 /* we use failed and not cPtr->state here, because cPtr may be
192 * destroyed by the delegate called above if the connection failed
196 } else if (cPtr
->state
== WCConnected
) {
197 WMFlushConnection(cPtr
);
204 /* if the connection died, may get destroyed in the delegate, so retain */
207 if ((mask
& WIReadMask
) && cPtr
->delegate
->didReceiveInput
)
208 (*cPtr
->delegate
->didReceiveInput
)(cPtr
->delegate
, cPtr
);
210 if ((mask
& WIExceptMask
) && cPtr
->delegate
->didCatchException
)
211 (*cPtr
->delegate
->didCatchException
)(cPtr
->delegate
, cPtr
);
218 setSocketNonBlocking(int sock
, Bool flag
) /*FOLD00*/
223 state
= fcntl(sock
, F_GETFL
, 0);
226 wsyserror("Failed to get socket flags with fcntl.");
230 isNonBlock
= (state
& NONBLOCK_OPT
) != 0;
235 state
|= NONBLOCK_OPT
;
239 state
&= ~NONBLOCK_OPT
;
242 if (fcntl(sock
, F_SETFL
, state
) < 0) {
243 wsyserror("Failed to set socket flags with fcntl.");
252 setConnectionAddress(WMConnection
*cPtr
, struct sockaddr_in
*socketaddr
) /*FOLD00*/
254 wassertr(cPtr
->address
==NULL
);
256 cPtr
->address
= wstrdup(inet_ntoa(socketaddr
->sin_addr
));
257 cPtr
->service
= wmalloc(16);
258 sprintf(cPtr
->service
, "%hu", ntohs(socketaddr
->sin_port
));
259 cPtr
->protocol
= wstrdup("tcp");
263 static struct sockaddr_in
*
264 getSocketAddress(char* name
, char* service
, char* protocol
) /*FOLD00*/
266 static struct sockaddr_in socketaddr
;
269 if (!protocol
|| protocol
[0]=='\0')
272 memset(&socketaddr
, 0, sizeof(struct sockaddr_in
));
273 socketaddr
.sin_family
= AF_INET
;
276 * If we were given a hostname, we use any address for that host.
277 * Otherwise we expect the given name to be an address unless it is
278 * NULL (any address).
280 if (name
&& name
[0]!='\0') {
281 WMHost
*host
= WMGetHostWithName(name
);
284 return NULL
; /* name is not a hostname nor a number and dot adr */
286 name
= WMGetHostAddress(host
);
287 #ifndef HAVE_INET_ATON
288 if ((socketaddr
.sin_addr
.s_addr
= inet_addr(name
)) == INADDR_NONE
) {
290 if (inet_aton(name
, &socketaddr
.sin_addr
) == 0) {
297 socketaddr
.sin_addr
.s_addr
= htonl(INADDR_ANY
);
300 if (!service
|| service
[0]=='\0') {
301 socketaddr
.sin_port
= 0;
302 } else if ((sp
= getservbyname(service
, protocol
))==0) {
306 portNumber
= strtoul(service
, &endptr
, 10);
308 if (service
[0]!='\0' && *endptr
=='\0' && portNumber
<65536) {
309 socketaddr
.sin_port
= htons(portNumber
);
314 socketaddr
.sin_port
= sp
->s_port
;
322 createConnectionWithSocket(int sock
, Bool closeOnRelease
) /*FOLD00*/
325 struct sigaction sig_action
;
327 cPtr
= wmalloc(sizeof(WMConnection
));
329 memset(cPtr
, 0, sizeof(WMConnection
));
332 cPtr
->sendTimeout
.timeout
= DEF_TIMEOUT
;
333 cPtr
->sendTimeout
.handler
= NULL
;
334 cPtr
->closeOnRelease
= closeOnRelease
;
335 cPtr
->outputQueue
= WMCreateBag(16);
336 cPtr
->state
= WCNotConnected
;
338 /* ignore dead pipe */
339 if (!SigInitialized
) {
340 sig_action
.sa_handler
= SIG_IGN
;
341 sig_action
.sa_flags
= SA_RESTART
;
342 sigaction(SIGPIPE
, &sig_action
, NULL
);
343 SigInitialized
= True
;
352 WMCreateConnectionWithSocket(int sock
, Bool closeOnRelease
) /*FOLD00*/
355 struct sockaddr_in clientname
;
358 cPtr
= createConnectionWithSocket(sock
, closeOnRelease
);
359 cPtr
->wasNonBlocking
= WMIsConnectionNonBlocking(cPtr
);
360 cPtr
->isNonBlocking
= cPtr
->wasNonBlocking
;
362 /* some way to find out if it is connected, and binded. can't find
363 if it listens though!!!
366 size
= sizeof(clientname
);
367 n
= getpeername(sock
, (struct sockaddr
*) &clientname
, &size
);
369 /* Since we have a peer, it means we are connected */
370 cPtr
->state
= WCConnected
;
372 size
= sizeof(clientname
);
373 n
= getsockname(sock
, (struct sockaddr
*) &clientname
, &size
);
375 /* We don't have a peer, but we are binded to an address.
376 * Assume we are listening on it (we don't know that for sure!)
378 cPtr
->state
= WCListening
;
380 cPtr
->state
= WCNotConnected
;
390 * host is the name on which we want to listen for incoming connections,
391 * and it must be a name of this host, or NULL if we want to listen
392 * on any incoming address.
393 * service is either a service name as present in /etc/services, or the port
394 * number we want to listen on. If NULL, a random port between
395 * 1024 and 65535 will be assigned to us.
396 * protocol is one of "tcp" or "udp". If NULL, "tcp" will be used by default.
397 * currently only "tcp" is supported.
400 WMCreateConnectionAsServerAtAddress(char *host
, char *service
, char *protocol
) /*FOLD00*/
403 struct sockaddr_in
*socketaddr
;
406 if ((socketaddr
= getSocketAddress(host
, service
, protocol
)) == NULL
) {
408 wwarning("Bad address-service-protocol combination");
412 /* Create the actual socket */
413 sock
= socket(PF_INET
, SOCK_STREAM
, 0);
416 wsyserror("Unable to create socket");
421 * Set socket options. We try to make the port reusable and have it
422 * close as fast as possible without waiting in unnecessary wait states
426 setsockopt(sock
, SOL_SOCKET
, SO_REUSEADDR
, (void *)&on
, sizeof(on
));
428 if (bind(sock
, (struct sockaddr
*)socketaddr
, sizeof(*socketaddr
)) < 0) {
430 wsyserror("Unable to bind to address '%s:%hu'",
431 inet_ntoa(socketaddr
->sin_addr
),
432 ntohs(socketaddr
->sin_port
));
437 if (listen(sock
, 10) < 0) {
439 wsyserror("Unable to listen on port '%hu'",
440 ntohs(socketaddr
->sin_port
));
445 /* Find out what is the address/service/protocol we get */
446 /* In case some of address/service/protocol were NULL */
447 size
= sizeof(*socketaddr
);
448 if (getsockname(sock
, (struct sockaddr
*)socketaddr
, &size
) < 0) {
450 wsyserror("Unable to get socket address");
455 cPtr
= createConnectionWithSocket(sock
, True
);
456 cPtr
->state
= WCListening
;
457 WMSetConnectionNonBlocking(cPtr
, True
);
459 setConnectionAddress(cPtr
, socketaddr
);
466 WMCreateConnectionToAddress(char *host
, char *service
, char *protocol
) /*FOLD00*/
469 struct sockaddr_in
*socketaddr
;
472 if (service
==NULL
|| service
[0]=='\0') {
474 wwarning("Bad argument - service is not specified");
478 if (host
==NULL
|| host
[0]=='\0')
481 if ((socketaddr
= getSocketAddress(host
, service
, protocol
)) == NULL
) {
483 wwarning("Bad address-service-protocol combination");
487 /* Create the actual socket */
488 sock
= socket(PF_INET
, SOCK_STREAM
, 0);
491 wsyserror("Unable to create socket");
494 /* make socket blocking while we connect. */
495 setSocketNonBlocking(sock
, False
);
496 if (connect(sock
, (struct sockaddr
*)socketaddr
, sizeof(*socketaddr
)) < 0) {
498 wsyserror("Unable to make connection to address '%s:%hu'",
499 inet_ntoa(socketaddr
->sin_addr
),
500 ntohs(socketaddr
->sin_port
));
505 cPtr
= createConnectionWithSocket(sock
, True
);
506 cPtr
->state
= WCConnected
;
507 WMSetConnectionNonBlocking(cPtr
, True
);
508 setConnectionAddress(cPtr
, socketaddr
);
515 WMCreateConnectionToAddressAndNotify(char *host
, char *service
, char *protocol
) /*FOLD00*/
518 /*TimeoutData *tPtr;*/
519 struct sockaddr_in
*socketaddr
;
523 if (service
==NULL
|| service
[0]=='\0') {
525 wwarning("Bad argument - service is not specified");
529 if (host
==NULL
|| host
[0]=='\0')
532 if ((socketaddr
= getSocketAddress(host
, service
, protocol
)) == NULL
) {
534 wwarning("Bad address-service-protocol combination");
538 /* Create the actual socket */
539 sock
= socket(PF_INET
, SOCK_STREAM
, 0);
542 wsyserror("Unable to create socket");
545 isNonBlocking
= setSocketNonBlocking(sock
, True
);
546 if (connect(sock
, (struct sockaddr
*)socketaddr
, sizeof(*socketaddr
)) < 0) {
547 if (errno
!=EINPROGRESS
) {
549 wsyserror("Unable to make connection to address '%s:%hu'",
550 inet_ntoa(socketaddr
->sin_addr
),
551 ntohs(socketaddr
->sin_port
));
557 cPtr
= createConnectionWithSocket(sock
, True
);
558 cPtr
->state
= WCInProgress
;
559 cPtr
->isNonBlocking
= isNonBlocking
;
561 /*tPtr = &cPtr->sendTimeout;
562 tPtr->handler = WMAddTimerHandler(tPtr->timeout*1000, connectTimeout, cPtr);
564 cPtr
->handler
.write
= WMAddInputHandler(cPtr
->sock
, WIWriteMask
,
567 setConnectionAddress(cPtr
, socketaddr
);
574 removeAllHandlers(WMConnection
*cPtr
) /*FOLD00*/
576 if (cPtr
->handler
.read
)
577 WMDeleteInputHandler(cPtr
->handler
.read
);
578 if (cPtr
->handler
.write
)
579 WMDeleteInputHandler(cPtr
->handler
.write
);
580 if (cPtr
->handler
.exception
)
581 WMDeleteInputHandler(cPtr
->handler
.exception
);
582 if (cPtr
->sendTimeout
.handler
)
583 WMDeleteTimerHandler(cPtr
->sendTimeout
.handler
);
585 cPtr
->handler
.read
= NULL
;
586 cPtr
->handler
.write
= NULL
;
587 cPtr
->handler
.exception
= NULL
;
588 cPtr
->sendTimeout
.handler
= NULL
;
593 WMDestroyConnection(WMConnection
*cPtr
) /*FOLD00*/
595 if (cPtr
->closeOnRelease
&& cPtr
->sock
>=0) {
596 shutdown(cPtr
->sock
, SHUT_RDWR
);
600 removeAllHandlers(cPtr
);
601 clearOutputQueue(cPtr
);
602 WMFreeBag(cPtr
->outputQueue
);
605 wfree(cPtr
->address
);
606 wfree(cPtr
->service
);
607 wfree(cPtr
->protocol
);
615 WMCloseConnection(WMConnection
*cPtr
) /*FOLD00*/
618 shutdown(cPtr
->sock
, SHUT_RDWR
);
623 removeAllHandlers(cPtr
);
624 clearOutputQueue(cPtr
);
626 cPtr
->state
= WCClosed
;
631 WMAcceptConnection(WMConnection
*listener
) /*FOLD00*/
633 struct sockaddr_in clientname
;
636 WMConnection
*newConnection
;
638 if (listener
->state
!=WCListening
) {
639 wwarning("Called 'WMAcceptConnection()' on a non-listening connection");
644 size
= sizeof(clientname
);
645 newSock
= accept(listener
->sock
, (struct sockaddr
*) &clientname
, &size
);
647 if (errno
!=EAGAIN
&& errno
!=EWOULDBLOCK
) {
649 wsyserror("Could not accept connection");
656 newConnection
= createConnectionWithSocket(newSock
, True
);
657 WMSetConnectionNonBlocking(newConnection
, True
);
658 newConnection
->state
= WCConnected
;
659 setConnectionAddress(newConnection
, &clientname
);
661 return newConnection
;
666 WMGetConnectionAddress(WMConnection
*cPtr
) /*FOLD00*/
668 return cPtr
->address
;
673 WMGetConnectionService(WMConnection
*cPtr
) /*FOLD00*/
675 return cPtr
->service
;
680 WMGetConnectionProtocol(WMConnection
*cPtr
)
682 return cPtr
->protocol
;
687 WMGetConnectionSocket(WMConnection
*cPtr
) /*FOLD00*/
694 WMGetConnectionState(WMConnection
*cPtr
) /*FOLD00*/
701 WMEnqueueConnectionData(WMConnection
*cPtr
, WMData
*data
) /*FOLD00*/
703 wassertrv(cPtr
->state
!=WCNotConnected
&& cPtr
->state
!=WCListening
, False
);
704 wassertrv(cPtr
->state
!=WCInProgress
&& cPtr
->state
!=WCFailed
, False
);
706 if (cPtr
->state
!=WCConnected
)
709 WMPutInBag(cPtr
->outputQueue
, WMRetainData(data
));
715 WMSendConnectionData(WMConnection
*cPtr
, WMData
*data
) /*FOLD00*/
717 int bytes
, pos
, len
, totalTransfer
;
718 TimeoutData
*tPtr
= &cPtr
->sendTimeout
;
719 const unsigned char *dataBytes
;
721 wassertrv(cPtr
->state
!=WCNotConnected
&& cPtr
->state
!=WCListening
, -1);
722 wassertrv(cPtr
->state
!=WCInProgress
&& cPtr
->state
!=WCFailed
, -1);
724 if (cPtr
->state
!=WCConnected
)
727 /* If we have no data just flush the queue, else try to send data */
728 if (data
&& WMGetDataLength(data
)>0) {
729 WMPutInBag(cPtr
->outputQueue
, WMRetainData(data
));
730 /* If there already was something in queue, and also a write input
731 * handler is established, it means we were unable to send, so
732 * return and let the write handler notify us when we can send.
734 if (WMGetBagItemCount(cPtr
->outputQueue
)>1 && cPtr
->handler
.write
)
740 while (WMGetBagItemCount(cPtr
->outputQueue
) > 0) {
741 data
= WMGetFromBag(cPtr
->outputQueue
, 0);
742 dataBytes
= (const unsigned char *)WMDataBytes(data
);
743 len
= WMGetDataLength(data
);
744 pos
= cPtr
->bufPos
; /* where we're left last time */
747 bytes
= write(cPtr
->sock
, dataBytes
+pos
, len
- pos
);
753 /* save the position where we're left and add a timeout */
755 if (!tPtr
->handler
) {
756 tPtr
->handler
= WMAddTimerHandler(tPtr
->timeout
*1000,
759 if (!cPtr
->handler
.write
) {
760 cPtr
->handler
.write
=
761 WMAddInputHandler(cPtr
->sock
, WIWriteMask
,
764 return totalTransfer
;
767 cPtr
->state
= WCDied
;
768 /*clearOutputQueue(cPtr);*/
769 removeAllHandlers(cPtr
);
770 if (cPtr
->delegate
&& cPtr
->delegate
->didDie
)
771 (*cPtr
->delegate
->didDie
)(cPtr
->delegate
, cPtr
);
776 totalTransfer
+= bytes
;
779 WMDeleteFromBag(cPtr
->outputQueue
, 0);
782 WMDeleteTimerHandler(tPtr
->handler
);
783 tPtr
->handler
= NULL
;
785 if (cPtr
->handler
.write
) {
786 WMDeleteInputHandler(cPtr
->handler
.write
);
787 cPtr
->handler
.write
= NULL
;
791 return totalTransfer
;
796 * WMGetConnectionAvailableData(connection):
798 * will return a WMData structure containing the available data on the
799 * specified connection. If connection is non-blocking (default) and no data
800 * is available when this function is called, an empty WMData is returned.
802 * If an error occurs while reading or the other side closed connection,
803 * it will return NULL.
804 * Also trying to read from an already died or closed connection is
805 * considered to be an error condition, and will return NULL.
808 WMGetConnectionAvailableData(WMConnection
*cPtr
) /*FOLD00*/
810 char buffer
[NETBUF_SIZE
];
814 wassertrv(cPtr
->state
!=WCNotConnected
&& cPtr
->state
!=WCListening
, NULL
);
815 wassertrv(cPtr
->state
!=WCInProgress
&& cPtr
->state
!=WCFailed
, NULL
);
817 if (cPtr
->state
!=WCConnected
)
823 nbytes
= read(cPtr
->sock
, buffer
, NETBUF_SIZE
);
829 aData
= WMCreateDataWithCapacity(0);
833 cPtr
->state
= WCDied
;
834 removeAllHandlers(cPtr
);
835 if (cPtr
->delegate
&& cPtr
->delegate
->didDie
)
836 (*cPtr
->delegate
->didDie
)(cPtr
->delegate
, cPtr
);
839 } else if (nbytes
==0) { /* the other side has closed connection */
840 cPtr
->state
= WCClosed
;
841 removeAllHandlers(cPtr
);
842 if (cPtr
->delegate
&& cPtr
->delegate
->didDie
)
843 (*cPtr
->delegate
->didDie
)(cPtr
->delegate
, cPtr
);
845 aData
= WMCreateDataWithBytes(buffer
, nbytes
);
853 WMSetConnectionDelegate(WMConnection
*cPtr
, ConnectionDelegate
*delegate
) /*FOLD00*/
855 wassertr(cPtr
->sock
>= 0);
856 /* Don't try to set the delegate multiple times */
857 wassertr(cPtr
->delegate
== NULL
);
859 cPtr
->delegate
= delegate
;
860 if (delegate
&& delegate
->didReceiveInput
&& !cPtr
->handler
.read
)
861 cPtr
->handler
.read
= WMAddInputHandler(cPtr
->sock
, WIReadMask
,
863 if (delegate
&& delegate
->didCatchException
&& !cPtr
->handler
.exception
)
864 cPtr
->handler
.exception
= WMAddInputHandler(cPtr
->sock
, WIExceptMask
,
871 WMIsConnectionNonBlocking(WMConnection
*cPtr
) /*FOLD00*/
876 state
= fcntl(cPtr
->sock
, F_GETFL
, 0);
879 wsyserror("Failed to get socket flags with fcntl.");
880 /* If we can't use fcntl on socket, this probably also means we could
881 * not use fcntl to set non-blocking mode, and since a socket defaults
882 * to blocking when created, return False as the best assumption */
886 return ((state
& NONBLOCK_OPT
)!=0);
888 return cPtr
->isNonBlocking
;
895 WMSetConnectionNonBlocking(WMConnection
*cPtr
, Bool flag
) /*FOLD00*/
900 if (cPtr
->isNonBlocking
== flag
)
903 if (setSocketNonBlocking(cPtr
->sock
, flag
)==True
)
904 cPtr
->isNonBlocking
= flag
;
909 WMGetConnectionClientData(WMConnection
*cPtr
) /*FOLD00*/
911 return cPtr
->clientData
;
916 WMSetConnectionClientData(WMConnection
*cPtr
, void *data
) /*FOLD00*/
918 cPtr
->clientData
= data
;
923 WMGetConnectionFlags(WMConnection
*cPtr
) /*FOLD00*/
930 WMSetConnectionFlags(WMConnection
*cPtr
, unsigned int flags
) /*FOLD00*/
932 cPtr
->uflags
= flags
;
937 WMSetConnectionSendTimeout(WMConnection
*cPtr
, unsigned int timeout
) /*FOLD00*/
940 timeout
= DEF_TIMEOUT
;
942 cPtr
->sendTimeout
.timeout
= timeout
;