GCDAsyncSocket tag parameter

Question

I'm wondering how to use the tag parameter in methods such as

readDataWithTimeout: tag:
writeData: tag:

What happens if I want to use the tag to identify the type of packet ? For example is I say tag == 2 means that the packet is a message from a client, tag == 1 means that the packet is a message from the server ... If this is ok do I need to call readData: withTag: several times (once for each different tag) ?

[readDataWithTimeout:-1 tag:1];
[readDataWithTimeout:-1 tag:2];

Is there a way to say: "read every data without caring about the tag", and then in the didReadData: withTag: method handle the data according to the tag ?

Matt Wilding · Accepted Answer · 2013-10-07T18:08:29.380

6

I think you're slightly misunderstanding the tag concept. The read operations aren't saying "Read data that has been tagged as 2". They are saying "Read the next data off the wire, and tag it as 2 for future reference."

The tag is never sent over the wire - the server didn't tag the data and send it to the client to read. It's a completely optional concept only used to distinguish local operations from each other. In other words, The data being read has no tag. The tag is something you assign to the read operation, so you can identify it later once it's complete.

For example, say you're reading data as a series of headers and payloads. You could use the tag to distinguish a header read from a payload read:

const NSInteger kHeaderTag = 1;
const NSInteger kPayloadTag = 2;

// Assume you know to expect a header, so tag the read operation as such.
[self readDataWithTimeout:-1 tag:kHeaderTag];

// Next assume you know to expect a payload, so tag the read operation as such.
[self readDataWithTimeout:-1 tag:kPayloadTag];

Then you can identify it later...

- (void)socket:(GCDAsyncSocket *)sock didReadData:(NSData *)data withTag:(long)tag
{
    if (tag == kHeaderTag)
    {
        // Handle header
    }
    else if (tag == kPayloadTag)
    {
        // Handle payload
    }
}

edited Oct 07 '13 at 18:08

answered Jul 17 '12 at 15:55

Matt Wilding

20,115
3
67
95

Thank you, I read the doc more carefully and understood that. To identify the "type" of packets, I decided to wrap all my data in a NSDictionary, with a key that allows me to identify packet. For example when I read a NSData, I extract the key (NSString) and according to the key handle the packet. Is that a good practice or should I change my approach ? – rmonjo Jul 18 '12 at 08:14
@user1437126 So you're serializing the dictionary as well as the data? Sounds fine to me. – Matt Wilding Jul 18 '12 at 15:23
Yes, that's what I do. Tested this solution all afternoon, efficient and clean. Again thanks for your reply – rmonjo Jul 18 '12 at 16:56
1

It REALLY needs to clarify in the GCDAsyncSocket doc that the tag is not sent through the network. Great, I wasted a lot of time setting up my server to recognize tags sent by the client. You probably saved me more time. – sudo Oct 06 '13 at 05:17

GCDAsyncSocket tag parameter

1 Answers1