Add support for getting clients in a given room

[FREEZX]

Added a clients function that calls the adapter's clients function, in order to get the connected clients in a room.
Pull requests implementing the underlying adapter functions:
Redis adapter: socketio/socket.io-redis-adapter#15
Memory adapter: socketio/socket.io-adapter#5

[rauchg]

Room should be optional right?

[rauchg]

clients(fn) should work

[rauchg]

Thanks for submitting this btw!

[FREEZX]

Sorry, i only made it for getting clients in a given room, though i'll try to do that tomorrow.
Please also check the mentioned pull requests when you can, the redis one needs a little attention, because i have no idea how to properly clean up the database on exit.

[FREEZX]

I made the base adapter work without the room parameter. I'll add this into the redis adapter as well, though i still need to do something to clean up redis on normal exit.

[julianlam]

👍

[panuhorsmalahti]

+1

[mikaturunen]

👍

[ryanhestin]

Not to blow up this thread, but you already can get the list of clients in a room.

io['sockets']['adapter']['rooms'] returns a dictionary of all the rooms currently open as the key and a dictionary of all clients and their current status in the room as the value (key:value).

Is this not sufficient? Am I missing something? Should this data not be accessed directly or is this PR merely a convenience thing?

[panuhorsmalahti]

That doesn't give a list of all the clients connected to all the rooms. It's a convenience I guess, but makes migration from socket-io 0.9 to 1.0 a lot easier.

[FREEZX]

Also, it doesn't work in a multi node environment.

[ghost]

@hestinr12 Now we have an official redis adapter and there's no way to get that dictionary from redis adapter. A convenient API for getting clients is pretty much required for some use cases as discussed earlier in #1428

[ryanhestin]

@panuhorsmalahti in what case does it not?

@FREEZX mostly out of curiosity, why does that occur? Is this just a reference to the local instance's connections?

@bdemirkir so to clarify, this is provides an interface to the redis cache handling the multi-node environment?

[ghost]

@hestinr12 Yes. Please look at these PRs:

• Add support for getting clients in a given room (Works across multiple nodes) socket.io-redis-adapter#15
• Add support for getting clients in a given room socket.io-adapter#5

[panuhorsmalahti]

@hestinr12
As I understand it, you would need to convert that object of rooms of clients to clients to get the 0.9 functionality (and filter out duplicates). Only a few lines of code, but it makes the migration easier. More importantly, most programmers are not aware of io['sockets']['adapter']['rooms']. It should be documented in the migration guide at least.

[panuhorsmalahti]

Hmm,

io['sockets']['adapter']['sids'] ===
{"T6DaL1e3HD8y41KYAAAA":{"T6DaL1e3HD8y41KYAAAA":true},"UzoTueQjgPvQbWusAAAB":{"UzoTueQjgPvQbWusAAAB":true} /* ... */

So I can get an array of socket ids, but how can I get the actual socket connections using the ids?

[FREEZX]

@panuhorsmalahti try with io.sockets.connected[id]

[indrekj]

+1

[paulosborne]

+1

[julianlam]

Was this actually merged, or just closed?

[rauchg]

We have another issue tracking this I believe. Is this why you closed @defunctzombie ?

[defunctzombie]

I thought it was merged per the comment of "coming in next release". Sorry if that is not the case yet.

[defunctzombie]

If this is ready for merge, could the OP please cleanup the commit history.

[rauchg]

It's not though.

[panuhorsmalahti]

In which version is this feature coming?

[bcharbonnier]

Is it part of 1.3.x or not ? I can't see it in the release notes changes .....
I mean, the real question is: did the bug get fixed somehow via another PR ?

[rauchg]

It's the top priority for our next release. #1945

[bcharbonnier]

Great! Thanks :)

[hayksaakian]

Not clear if this is in or not? (It's been a few months since last comment on this pull)

[marksyzm]

:) It is not. I'm guessing... soon.

[luin]

Any updates on this pr?

[emadd]

+1

[austinkelleher]

+1

[wanming]

getClientsInRoom: (io, roomName) ->
    ret = []
    room = io.sockets.adapter.rooms[roomName]

    return ret if !room

    for socketID of room
      ret.push(io.sockets.connected[socketID])
    ret

[benkaiser]

+1

[samuel281]

I'm still waiting for this feature. Is there any blocker?

[LordMajestros]

@samuel281 needs to be rebased

[Shadowstep33]

+1

[Shadowstep33]

io['sockets']['adapter']['sids'] is returning an empty literal for me even though a client is clearly connected

[JCMais]

For anyone interested, I'm currently using the following to accomplish that:

io.in( room ).clients(function( error, clients ) {
    if (error) throw error;
    for ( var i = 0, len = clients.length; i < len; i++ ) {
        io.sockets.connected[clients[i]].emit( 'something', {some: 'data'} );
    }
});

[darrachequesne]

Closed by socketio/socket.io-adapter#24 and socketio/socket.io-redis-adapter#109. Thanks!