|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IfmapChannel
Interface for an IF-MAP communication channel
Method Summary | |
---|---|
void |
closeTcpConnection()
Closes the underlying TCP connection. |
Result |
genericRequest(Request req)
Generic Request Interface |
Result |
genericRequestWithSessionId(Request req)
|
Integer |
getMaxPollResSize()
|
String |
getPublisherId()
|
String |
getSessionId()
|
void |
setGzip(boolean useGzip)
Specifies whether GZIP compression should be used. |
void |
setMaxPollResSize(Integer mprs)
Set the max-poll-result-size for this channel. |
void |
setPublisherId(String publisherId)
Set the ifmap-publisher-id for this channel. |
void |
setSessionId(String sessionId)
Set the session-id to be used for this channel. |
boolean |
usesGzip()
Indicates whether GZIP compression is used by this channel |
Method Detail |
---|
String getSessionId()
SSRC.newSession()
or setSessionId(String)
,
or null if none of these calls was made.void setSessionId(String sessionId)
ARC
will change the SSRC
object attached to the
ARC
. Calling it on an SSRC
will also change the attached
ARC
objects for the SSRC
.
String getPublisherId()
SSRC.newSession()
or setPublisherId(String)
,
or null if none of these calls was made.void setPublisherId(String publisherId)
ARC
will change the SSRC
object attached to the
ARC
. Calling it on an SSRC
will also change the attached
ARC
objects for the SSRC
.
This call will only result in having getPublisherId()
return
the set value. Requests won't be influenced.
Integer getMaxPollResSize()
SSRC.newSession()
or setMaxPollResSize(Integer)
,
or null if none of these calls was made.void setMaxPollResSize(Integer mprs)
ARC
will change the SSRC
object attached to the
ARC
. Calling it on an SSRC
will also change the attached
ARC
objects for the SSRC
.
This call will only result in having getMaxPollResSize()
return
the set value. Requests won't be influenced.
void closeTcpConnection() throws CommunicationException
CommunicationException
void setGzip(boolean useGzip)
useGzip
- true if GZIP should be usedboolean usesGzip()
Result genericRequest(Request req) throws IfmapErrorResult, IfmapException
req
-
IfmapErrorResult
IfmapException
Result genericRequestWithSessionId(Request req) throws IfmapErrorResult, IfmapException
IfmapErrorResult
IfmapException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |