APE_JSF Users Channels and Pipes

Louis Charette edited this page Apr 19, 2014 · 1 revision

Users

Users are entities identified by a Public ID (Pubid). Actual communication to and from a user is not done using the user itself, but using a pipe. Each user has a pipe for this purpose.

Subusers

See [Subusers](APE Server Subusers).

Channels

Channels are entities identified by a Public ID (Pubid). Actual communication to and from a channel is not done using the channel itself, but using a pipe. Each channel has a pipe for this purpose.

There are 2 types of channels: *Interactive *Non-interactive (read-only / receiving only)

Both types of channels can be joined by users, but unlike an "Interactive" channel, users cannot send messages to "Non-interactive" channels. The communication of a "Non-interactive" channel is 1-directional so to speak, The server can send messages to clients, but clients cannot send messages to the server. (messages wont be forwarded to all members of that group)

Non-interactive channels are usefull when users shouldn't be able to post messages.

for example when content is only to be updated by an admin and not by users like when publishing (news) feed updates.

Pipes

Both users and channels have a pipe, which acts as the actual communicator.

Pipes created manually (custom pipes) are a little different from user and channel pipes. A manually created pipe is just usefull to receive "SEND" commands from clients (Proxy pipes are working this way). See example for more details.

User and Channel Properties:

Both users and channels can have private and public properties.

Private properties are only seen by the APE server and are not propagated to the client. Public properties are automatically propagated to the client

See [Private Public and Session Properties](APE Server Private Public and Session Properties).