|
ICEpush 3.3.0 Java API Documentation |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.icepush.PushContext
public class PushContext
Constructor Summary | |
---|---|
PushContext(javax.servlet.ServletContext context)
Constructs a new PushContext using the specified context . |
Method Summary | |
---|---|
void |
addGroupMember(java.lang.String groupName,
java.lang.String pushId)
Adds the specified pushId to the group with the specified groupName . |
void |
backOff(java.lang.String browserID,
long delay)
Instructs the specified browser to back off from ajax push listen for the specified number of milliseconds. |
java.lang.String |
createPushId(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Creates a Push ID consisting of the Browser ID and Sub ID. |
static PushContext |
getInstance(javax.servlet.ServletContext context)
Gets the PushContext instance associated with the specified context . |
void |
push(java.lang.String groupName)
Initiate a Server Push to the members of the group specified by the groupName . |
void |
push(java.lang.String groupName,
PushConfiguration config)
Initiate a Server Push to the members of the group specified by the groupName . |
void |
removeGroupMember(java.lang.String groupName,
java.lang.String pushId)
Removes the specified pushId from the group with the specified groupName . |
void |
setPushGroupManager(PushGroupManager pushGroupManager)
Sets the push group manager. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PushContext(javax.servlet.ServletContext context)
Constructs a new PushContext using the specified context
.
context
- The ServletContext.Method Detail |
---|
public void backOff(java.lang.String browserID, long delay)
Instructs the specified browser to back off from ajax push listen for the specified number of milliseconds.
browserID
- The ICEpush browser ID as stored in the ice.push.browser cookie.delay
- The delay in milliseconds the browser needs to back off.public java.lang.String createPushId(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
Creates a Push ID consisting of the Browser ID and Sub ID. If the specified request
does not
contain a Browser ID already, it will be created and set on the specified request
and
response
.
request
- The HTTP Servlet request.response
- The HTTP Servlet response.
public void push(java.lang.String groupName)
Initiate a Server Push to the members of the group specified by the groupName
.
groupName
- The group name of the group.push(String, PushConfiguration)
public void push(java.lang.String groupName, PushConfiguration config)
Initiate a Server Push to the members of the group specified by the groupName
.
groupName
- The group name of the group.config
- The Push configuration.push(String)
public void addGroupMember(java.lang.String groupName, java.lang.String pushId)
Adds the specified pushId
to the group with the specified groupName
.
groupName
- The name of the group the specified pushId
needs to be added to.pushId
- The Push ID that needs to be added.public void removeGroupMember(java.lang.String groupName, java.lang.String pushId)
Removes the specified pushId
from the group with the specified groupName
.
groupName
- The name of the group the specified pushId
needs to be removed from.pushId
- The Push ID that needs to be removed.public void setPushGroupManager(PushGroupManager pushGroupManager)
Sets the push group manager.
Note: This method is not intended for application use!
pushGroupManager
- public static PushContext getInstance(javax.servlet.ServletContext context)
Gets the PushContext instance associated with the specified context
.
context
- The ServletContext from which to get the PushContext.
|
ICEpush 3.3.0 Java API Documentation |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |