org.elastos.carrier

Class AbstractCarrierHandler

java.lang.Object

org.elastos.carrier.AbstractGroupHandler

org.elastos.carrier.AbstractCarrierHandler

All Implemented Interfaces:

CarrierHandler, GroupHandler

public abstract class AbstractCarrierHandler
extends AbstractGroupHandler
implements CarrierHandler

The abstract carrier node handler class.

Constructor Summary

Constructors

Constructor and Description
AbstractCarrierHandler()

Method Summary

Modifier and Type	Method and Description
void	onConnection(Carrier carrier, ConnectionStatus status) The callback function to process the self connection status.
void	onFriendAdded(Carrier carrier, FriendInfo info) The callback function to process the new friend added event.
void	onFriendConnection(Carrier carrier, java.lang.String friendId, ConnectionStatus status) The callback function to process the friend connections status changed event.
void	onFriendInfoChanged(Carrier carrier, java.lang.String friendId, FriendInfo info) The callback function to process the friend information changed event.
void	onFriendInviteRequest(Carrier carrier, java.lang.String from, java.lang.String data) The callback function to process the friend invite request.
void	onFriendMessage(Carrier carrier, java.lang.String from, byte[] message, java.util.Date timestamp, boolean isOffline) The callback function to process the friend message.
void	onFriendPresence(Carrier carrier, java.lang.String friendId, PresenceStatus presence) The callback function to process the friend presence changed event.
void	onFriendRemoved(Carrier carrier, java.lang.String friendId) The callback function to process the friend removed event.
void	onFriendRequest(Carrier carrier, java.lang.String userId, UserInfo info, java.lang.String hello) The callback function to process the friend request.
void	onFriends(Carrier carrier, java.util.List<FriendInfo> friends) The callback function to iterate the each friend item in friend list.
void	onGroupInvite(Carrier carrier, java.lang.String from, byte[] cookie) The callback function to process the group invite request.
void	onIdle(Carrier carrier) The callback function that perform idle work.
void	onReady(Carrier carrier) The callback function to process the ready notification.
void	onSelfInfoChanged(Carrier carrier, UserInfo info) The callback function to process the self info changed event.

Methods inherited from class org.elastos.carrier.AbstractGroupHandler

onGroupConnected, onGroupMessage, onGroupTitle, onPeerListChanged, onPeerName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.elastos.carrier.GroupHandler

onGroupConnected, onGroupMessage, onGroupTitle, onPeerListChanged, onPeerName

Constructor Detail

AbstractCarrierHandler

public AbstractCarrierHandler()

Method Detail

onIdle

public void onIdle(Carrier carrier)

The callback function that perform idle work.

Specified by:

onIdle in interface CarrierHandler

Parameters:

carrier - Carrier node instance

onConnection

public void onConnection(Carrier carrier,
                         ConnectionStatus status)

The callback function to process the self connection status.

Specified by:

onConnection in interface CarrierHandler

Parameters:

carrier - Carrier node instance

status - Current connection status. @see ConnectionStatus

onReady

public void onReady(Carrier carrier)

The callback function to process the ready notification. Application should wait this callback invoked before calling any carrier function to interact with friends.

Specified by:

onReady in interface CarrierHandler

Parameters:

carrier - Carrier node instance

onSelfInfoChanged

public void onSelfInfoChanged(Carrier carrier,
                              UserInfo info)

The callback function to process the self info changed event.

Specified by:

onSelfInfoChanged in interface CarrierHandler

Parameters:

carrier - Carrier node instance

info - The updated user information

onFriends

public void onFriends(Carrier carrier,
                      java.util.List<FriendInfo> friends)

The callback function to iterate the each friend item in friend list.

Specified by:

onFriends in interface CarrierHandler

Parameters:

carrier - Carrier node instance

friends - The friends list.

onFriendConnection

public void onFriendConnection(Carrier carrier,
                               java.lang.String friendId,
                               ConnectionStatus status)

The callback function to process the friend connections status changed event.

Specified by:

onFriendConnection in interface CarrierHandler

Parameters:

carrier - carrier node instance.

friendId - The friend's user id.

status - The connection status of friend. @see ConnectionStatus

onFriendInfoChanged

public void onFriendInfoChanged(Carrier carrier,
                                java.lang.String friendId,
                                FriendInfo info)

The callback function to process the friend information changed event.

Specified by:

onFriendInfoChanged in interface CarrierHandler

Parameters:

carrier - Carrier node instance

friendId - The friend's user id

info - The update friend information

onFriendPresence

public void onFriendPresence(Carrier carrier,
                             java.lang.String friendId,
                             PresenceStatus presence)

The callback function to process the friend presence changed event.

Specified by:

onFriendPresence in interface CarrierHandler

Parameters:

carrier - Carrier node instance

friendId - The friend's user id

presence - The presence status of the friend

onFriendRequest

public void onFriendRequest(Carrier carrier,
                            java.lang.String userId,
                            UserInfo info,
                            java.lang.String hello)

The callback function to process the friend request.

Specified by:

onFriendRequest in interface CarrierHandler

Parameters:

carrier - Carrier node instance

userId - The user id who want be friend with current user

info - The user information to `userId`

hello - The PIN for target user, or any application defined content

onFriendAdded

public void onFriendAdded(Carrier carrier,
                          FriendInfo info)

The callback function to process the new friend added event.

Specified by:

onFriendAdded in interface CarrierHandler

Parameters:

carrier - Carrier node instance

info - The added friend's information

onFriendRemoved

public void onFriendRemoved(Carrier carrier,
                            java.lang.String friendId)

The callback function to process the friend removed event.

Specified by:

onFriendRemoved in interface CarrierHandler

Parameters:

carrier - Carrier node instance

friendId - The friend's user id

onFriendMessage

public void onFriendMessage(Carrier carrier,
                            java.lang.String from,
                            byte[] message,
                            java.util.Date timestamp,
                            boolean isOffline)

The callback function to process the friend message.

Specified by:

onFriendMessage in interface CarrierHandler

Parameters:

carrier - Carrier node instance

from - The id(userid@nodeid) from who send the message

timestamp - The message sent time as the number of seconds since the Epoch, 1970-01-01 00:00:00 +0000 (UTC)

isOffline - The boolean value means this message is received as offline message or online message. The vlaue of true means the message is received as offline message, otherwise as online message.

message - The message content

onFriendInviteRequest

public void onFriendInviteRequest(Carrier carrier,
                                  java.lang.String from,
                                  java.lang.String data)

The callback function to process the friend invite request.

Specified by:

onFriendInviteRequest in interface CarrierHandler

Parameters:

carrier - Carrier node instance

from - The user id from who send the invite request

data - The application defined data sent from friend

onGroupInvite

public void onGroupInvite(Carrier carrier,
                          java.lang.String from,
                          byte[] cookie)

The callback function to process the group invite request.

Specified by:

onGroupInvite in interface CarrierHandler

Parameters:

carrier - Carrier node instance

from - The user id from who send the invite request

cookie - The application defined cookie send from friend