3 * Copyright (c) 2002 - 2007, Blue Static <http://www.bluestatic.org>
5 * This program is free software; you can redistribute it and/or modify it under the terms of the GNU
6 * General Public License as published by the Free Software Foundation; either version 2 of the
7 * License, or (at your option) any later version.
9 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
10 * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * General Public License for more details.
13 * You should have received a copy of the GNU General Public License along with this program; if not,
14 * write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
17 #import "SocketWrapper.h"
18 #include <sys/types.h>
19 #include <sys/socket.h>
20 #include <netinet/in.h>
21 #include <arpa/inet.h>
24 NSString
*SocketWrapperDidErrorNotification
= @
"errorOccurred";
25 NSString
*SocketWrapperSocketDidBindNotification
= @
"bindSuccess";
26 NSString
*SocketWrapperSocketDidAcceptNotification
= @
"acceptSuccess";
27 NSString
*SocketWrapperDataReceivedNotification
= @
"dataReceived";
28 NSString
*SocketWrapperDataSentNotification
= @
"dataSent";
30 @implementation SocketWrapper
33 * Initializes the socket wrapper with a host and port
35 - (id)initWithPort
: (int)port
37 if (self = [super init
])
39 // create an INET socket that we'll be listen()ing on
40 int socketOpen
= socket(PF_INET
, SOCK_STREAM
, 0);
42 // create our address given the port
43 struct sockaddr_in address
;
44 address.sin_family
= AF_INET
;
45 address.sin_port
= htons(port
);
46 address.sin_addr.s_addr
= htonl(INADDR_ANY
);
47 memset(address.sin_zero
, '\0', sizeof(address.sin_zero
));
49 // bind the socket... and don't give up until we've tried for a while
51 while (bind(socketOpen
, (struct sockaddr
*)&address
, sizeof(address
)) < 0)
56 [[NSNotificationCenter defaultCenter
] postNotificationName
: SocketWrapperDidErrorNotification object
: @
"bind failed"];
59 NSLog(@
"couldn't bind to the socket... trying again in 5");
63 [[NSNotificationCenter defaultCenter
] postNotificationName
: SocketWrapperSocketDidBindNotification object
: self];
65 // now we just have to keep our ears open
66 if (listen(socketOpen
, 0) == -1)
68 [[NSNotificationCenter defaultCenter
] postNotificationName
: SocketWrapperDidErrorNotification object
: @
"listen failed"];
72 // accept a connection
73 struct sockaddr_in remoteAddress
;
74 socklen_t remoteAddressLen
= sizeof(remoteAddress
);
75 _socket
= accept(socketOpen
, (struct sockaddr
*)&remoteAddress
, &remoteAddressLen
);
79 [[NSNotificationCenter defaultCenter
] postNotificationName
: SocketWrapperDidErrorNotification object
: @
"accept failed"];
82 [[NSNotificationCenter defaultCenter
] postNotificationName
: SocketWrapperSocketDidAcceptNotification object
: self];
84 // we're done listening now that we have a connection
91 * Close our socket and clean up anything else
101 * Returns the delegate
109 * Sets the delegate but does *not* retain it
111 - (void)setDelegate
: (id)delegate
113 if (_delegate
!= nil)
115 [[NSNotificationCenter defaultCenter
] removeObserver
: _delegate
];
118 _delegate
= delegate
;
120 NSLog(@
"responds to ? %d", [_delegate respondsToSelector
: @selector(dataReceived
:)]);
122 [[NSNotificationCenter defaultCenter
] addObserver
: _delegate selector
: @selector(errorEncountered
:) name
: SocketWrapperDidErrorNotification object
: self];
123 [[NSNotificationCenter defaultCenter
] addObserver
: _delegate selector
: @selector(socketDidBind
:) name
: SocketWrapperSocketDidBindNotification object
: self];
124 [[NSNotificationCenter defaultCenter
] addObserver
: _delegate selector
: @selector(socketDidAccept
:) name
: SocketWrapperSocketDidAcceptNotification object
: self];
125 [[NSNotificationCenter defaultCenter
] addObserver
: _delegate selector
: @selector(dataReceived
:) name
: nil object
: self];
126 [[NSNotificationCenter defaultCenter
] addObserver
: _delegate selector
: @selector(dataSent
:) name
: SocketWrapperDataSentNotification object
: self];
130 * Reads from the socket and returns the result as a NSString (because it's always going to be XML). Be aware
131 * that the underlying socket recv() call will *wait* for the server to send a message, so be sure that this
132 * is used either in a threaded environment so the interface does not hang, or when you *know* the server
133 * will return something (which we almost always do).
135 * Data string returned is autorelease'd
142 // do our initial recv() call to get (hopefully) all the data and the lengh of the packet
143 int recvd
= recv(_socket
, &buffer
, sizeof(buffer
), 0);
145 // take the received data and put it into an NSData
146 NSMutableData
*data
= [NSMutableData data
];
148 // strip the length from the packet, and clear the null byte then add it to the NSData
149 char packetLength
[32];
151 while (buffer
[i
] != '\0')
153 packetLength
[i
] = buffer
[i
];
156 // the length of the packet
157 // packet is formatted in len<null>packet
158 int length
= atoi(packetLength
);
160 // take our bytes and convert them to NSData
161 [data appendBytes
: &buffer
[i
+ 1] length
: recvd
];
163 // check if we have a partial packet
164 if (length
+ sizeof(length
) > sizeof(buffer
))
166 while (recvd
< length
)
168 int latest
= recv(_socket
, &buffer
, sizeof(buffer
), 0);
171 NSLog(@
"socket closed or error");
173 [data appendBytes
: buffer length
: latest
];
178 // convert the NSData into a NSString
179 NSString
*string
= [[[NSString alloc
] initWithData
: data encoding
: NSUTF8StringEncoding
] autorelease
];
181 [[NSNotificationCenter defaultCenter
] postNotificationName
: SocketWrapperDataReceivedNotification object
: string
];
187 * Sends a given NSString over the socket
189 - (void)send
: (NSString
*)data
191 data
= [NSString stringWithFormat
: @
"%@\0", data
];
192 int sent
= send(_socket
, [data UTF8String
], [data length
], 0);
195 NSLog(@
"error in sending");
197 if (sent
< [data length
])
199 // TODO - do we really need to worry about partial sends with the lenght of our commands?
200 NSLog(@
"FAIL: only partial packet was sent; sent %d bytes", sent
);
203 [[NSNotificationCenter defaultCenter
] postNotificationName
: SocketWrapperDataSentNotification object
: self];