|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--cnrg.itx.signal.SigPacket | +--cnrg.itx.signal.InvitePacket
This class extends SigPacket and is used in the 3-way handshake during a Dial Sequence.
Constructor Summary | |
InvitePacket()
Default Constructor for the InvitePacket |
|
InvitePacket(UserID s,
Location sl,
java.lang.String ad,
int meth)
Overloaded Constructor for the InvitePacket. |
Method Summary | |
void |
accept()
Applications call this method to indicate that they accept the invitation. |
void |
busy()
Applications call this method to indicate that they are busy at present and cannot accept the invitation. |
void |
confirm()
Applications call this method to confirm a sequence. |
java.lang.String |
getCallID()
Returns the call-id of the current call session |
java.lang.Long |
getCSeq()
Returns the initiating DesktopSignaling's connection sequence number |
java.lang.String |
getDescription()
Returns the description of the sender of the InvitePacket |
PropertiesCollection |
getPropertiesCollection()
Returns the senders' PropertiesCollection |
java.lang.String |
getReason()
Returns the reason an invitation was rejected |
UserID |
getSenderID()
Returns the UserID associated with the sender of the InvitePacket |
Location |
getSenderLoc()
Returns the Location associated with the sender of the InvitePacket |
java.lang.Long |
getSeqNumber()
Returns the sequence number associated with the recipient's InvitePacket |
void |
reject(java.lang.String r)
Applications call this method to indicate that they reject the invitation. |
void |
setAppDescription(java.lang.String s)
Sets the source description |
void |
setCallID(java.lang.String s)
Assigns the call-id of the current session. |
void |
setCSeq(java.lang.Long s)
Assigns the sequence number belonging to the initiating DesktopSignaling. |
void |
setPropertiesCollection(PropertiesCollection pc)
Assigns the source's PropertiesCollection for Data Exchange |
void |
setSeqNumber(java.lang.Long s)
Assigns the sequence number of the recipient for the packet. |
void |
setSourceID(UserID s)
Assigns the source UserID |
void |
setSourceLoc(Location l)
Assigns the source Location |
boolean |
wasAccepted()
Checks whether the Invitation sent was accepted by the peer application. |
boolean |
wasBusy()
Checks whether the peer application was busy. |
boolean |
wasConfirmed()
Checks whether it is a confirm packet . |
boolean |
wasRejected()
Checks whether the Invitation was rejected by the peer application. |
Methods inherited from class cnrg.itx.signal.SigPacket |
getCustomObject,
getDestination,
getMethodID,
getPacketID,
hasCustomObject,
isAliveQuery,
isConfirmPacket,
isDial,
isHangup,
isInvitePacket,
isResultPacket,
isSendDTMF,
setCustomObject,
setDestination,
setMethodType,
setPacketType |
Methods inherited from class java.lang.Object |
equals,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Constructor Detail |
public InvitePacket()
None
- public InvitePacket(UserID s, Location sl, java.lang.String ad, int meth)
s
- is the UserID object representing the sourcesl
- is the Location object representing the sourcead
- is the String description of the Sourcemeth
- is the integer representing the method idMethod Detail |
public UserID getSenderID()
None
- public Location getSenderLoc()
None
- public java.lang.String getDescription()
None
- public java.lang.String getReason()
None
- public PropertiesCollection getPropertiesCollection()
None
- public java.lang.String getCallID()
public java.lang.Long getCSeq()
public void setSourceID(UserID s)
s
- is the UserID object representing the senderpublic void setSourceLoc(Location l)
l
- is the Location object representing the sender's locationpublic void setAppDescription(java.lang.String s)
s
- is the String representing the sender's descriptionpublic void setPropertiesCollection(PropertiesCollection pc)
pc
- is the PropertiesCollection object representing the sender's PropertiesCollectionpublic void setSeqNumber(java.lang.Long s)
s
- is the Long object representing the sequence numberpublic java.lang.Long getSeqNumber()
None
- public void setCallID(java.lang.String s)
s
- the call-idpublic void setCSeq(java.lang.Long s)
s
- the sequence numberpublic void accept()
None
- public void reject(java.lang.String r)
r
- is the reason for rejectionpublic void busy()
None
- public void confirm()
None
- public boolean wasAccepted()
None.
- public boolean wasRejected()
None.
- public boolean wasBusy()
None.
- public boolean wasConfirmed()
None.
-
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |