|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--cnrg.itx.signal.DesktopSignaling
The primary Signaling Object that allows the application to access all telephony services.
Inner Class Summary | |
class |
DesktopSignaling.Result
Inner Class containing the result of a Dial Sequence. |
Constructor Summary | |
DesktopSignaling(SignalingObserver so)
Constructor for DesktopSignaling for applications that run without a Directory Service - i.e. |
|
DesktopSignaling(SignalingObserver so,
int port)
Constructor for DesktopSignaling for applications that run without a Directory Service - i.e. |
|
DesktopSignaling(SignalingObserver so,
java.lang.String uid,
int port)
Constructor for DesktopSignaling for applications that run without a Directory Service - i.e. |
|
DesktopSignaling(SignalingObserver so,
java.lang.String uid,
java.lang.String pass)
Constructor for a DesktopSignaling component for an application with no specified description and config file. |
|
DesktopSignaling(SignalingObserver so,
java.lang.String uid,
java.lang.String pass,
java.lang.String desc,
java.lang.String config)
Constructor for DesktopSignaling with an app description and config file for Directory Service |
|
DesktopSignaling(SignalingObserver so,
java.lang.String uid,
java.lang.String pass,
java.lang.String desc,
java.lang.String config,
boolean ifSIP)
Constructor for DesktopSignaling as above with a boolean stating if this uses the SIP protocol |
Method Summary | |
SignalConnection |
Dial(Location peerLoc)
Returns a SignalConnection containing the data connection object to be used to transferring sound data. |
SignalConnection |
Dial(Location peerLoc,
Channel cInput,
Channel cOutput)
Returns a SignalConnection containing the data connection object to be used to transferring sound data. |
SignalConnection |
Dial(Location peerLoc,
Channel cInput,
Channel cOutput,
SignalConnectionObserver sco)
Returns a SignalConnection containing the data connection object to be used to transferring sound data. |
SignalConnection |
Dial(Location peerLoc,
SignalConnectionObserver sco)
Returns a SignalConnection containing the data connection object to be used to transferring sound data. |
SignalConnection |
Dial(java.lang.String userid)
Dials a peer application and returns a SignalConnection containing the connection object to use for communication. |
SignalConnection |
Dial(java.lang.String userid,
Channel cInput,
Channel cOutput)
Returns a SignalConnection containing the connection object to use for communication. |
SignalConnection |
Dial(java.lang.String userid,
Location peerLoc)
Returns a SignalConnection containing the data connection object to be used to transferring sound data. |
SignalConnection |
Dial(java.lang.String userid,
Location destAdd,
Channel cInput,
Channel cOutput)
This is the primary Location-based, blocking, Dial method. |
SignalConnection |
Dial(java.lang.String userid,
Location userLoc,
Channel cInput,
Channel cOutput,
SignalConnectionObserver sco)
Returns a SignalConnection containing the connection object to use for communication. |
SignalConnection |
Dial(java.lang.String userid,
Location userLoc,
SignalConnectionObserver sco)
Returns a SignalConnection containing the connection object to use for communication. |
DirectoryService |
getDirectory()
This method allows application to get a handle to a ready-to-use Directory Service. |
LocationList |
getLocationList(java.lang.String userid)
This method allows an application to get a list of possible locations for a given user. |
java.lang.String |
getName()
Returns the name of the computer on which we are running |
int |
getPort()
This method returns the port on which the SignalingServer is listening |
int |
getTimeout()
This method returns the timeout value currently being used for socket connections by Signaling. |
void |
Hangup(SignalConnection sc)
Hangs up a given SignalConnection being used for a call. |
boolean |
isAlive(SignalConnection sc)
This method queries a peer application to check if it is still running. |
void |
logout()
This method unregisters the Signaling Component with Directory Services (if myDirS is not null) and kills the server thread. |
void |
sendDTMF(java.lang.String s,
SignalConnection sc)
This method sends a DTMF tone, as a string, to the destination on a given SignalConnection |
void |
setTimeout(int t)
This method allows the application to set the timeout value to use for socket connections. |
Methods inherited from class java.lang.Object |
equals,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Constructor Detail |
public DesktopSignaling(SignalingObserver so, java.lang.String uid, java.lang.String pass) throws DirectoryServiceException
so
- the SignalingObserver handle for the Applicationuid
- the UserID of the userpass
- the password of the userDirectoryServiceException
public DesktopSignaling(SignalingObserver so, java.lang.String uid, java.lang.String pass, java.lang.String desc, java.lang.String config) throws DirectoryServiceException
so
- the SignalingObserver handle for the Applicationuid
- the UserID of the userpass
- the password of the userdesc
- the String representing the type of application instantiating this componentconfig
- is the name of the configuration file to use for Directory ServiceDirectoryServiceException
public DesktopSignaling(SignalingObserver so, java.lang.String uid, java.lang.String pass, java.lang.String desc, java.lang.String config, boolean ifSIP) throws DirectoryServiceException
so
- the SignalingObserver handle for the Applicationuid
- the UserID of the userpass
- the password of the userdesc
- the String representing the type of application instantiating this componentconfig
- is the name of the configuration file to use for Directory ServiceifSIP
- true if DesktopSignaling uses SIP; false otherwiseDirectoryServiceException
public DesktopSignaling(SignalingObserver so)
so
- - SignalingObserver that will handle SigEventspublic DesktopSignaling(SignalingObserver so, int port)
this
- - SignalingObserver that will handle SigEventsport
- - the port on which the server should listen. (If 0,
the server will listen on any free port)public DesktopSignaling(SignalingObserver so, java.lang.String uid, int port)
this
- - SignalingObserver that will handle SigEventsuid
- - String representing the identity of the client.port
- - the port on which the server should listen. (If 0,
the server will listen on any free port)Method Detail |
public SignalConnection Dial(java.lang.String userid) throws DataException, DesktopSignalingException, DirectoryServiceException
userid
- the String representing the email address or phone number or userID to callSignalConnection
,
DataException
,
DesktopSignalingException
,
DirectoryServiceException
public SignalConnection Dial(java.lang.String userid, Channel cInput, Channel cOutput) throws DataException, DesktopSignalingException, DirectoryServiceException
userid
- the String representing the email address or phone number or userID to callcInput
- Input Channel to add to resultcOutput
- Output Channel to add to resultSignalConnection
,
DataException
,
DesktopSignalingException
,
DirectoryServiceException
public SignalConnection Dial(java.lang.String userid, Location userLoc, SignalConnectionObserver sco) throws DataException, DesktopSignalingException
userid
- the String representing the email address or phone number or userID to calluserLoc
- the Location object that needs to be dialed.sco
- the SignalConnectionObserver object that is used by the application to control the dial processSignalConnectionObserver
,
SignalConnection
,
DataException
,
DesktopSignalingException
public SignalConnection Dial(java.lang.String userid, Location userLoc, Channel cInput, Channel cOutput, SignalConnectionObserver sco) throws DataException, DesktopSignalingException
userid
- the String representing the email address or phone number or userID to calluserLoc
- the Location object that needs to be dialedcInput
- the input channel to use for data exchangecOutput
- the output channel to use for data exchangesco
- the SignalConnectionObserver object that is used by the application to control the dial processSignalConnectionObserver
,
SignalConnection
,
DataException
,
DesktopSignalingException
public SignalConnection Dial(Location peerLoc) throws DataException, DesktopSignalingException
peerLoc
- - the Location of our peerpublic SignalConnection Dial(Location peerLoc, Channel cInput, Channel cOutput) throws DataException, DesktopSignalingException
peerLoc
- - the Location of our peercInput
- - Input channel to be used for data communicationscOuput
- - output channel to be used for data communicationspublic SignalConnection Dial(java.lang.String userid, Location peerLoc) throws DataException, DesktopSignalingException
userid
- - name for server app, our peerpeerLoc
- - the Location of our peerpublic SignalConnection Dial(java.lang.String userid, Location destAdd, Channel cInput, Channel cOutput) throws DataException, DesktopSignalingException
userid
- - name for server app, our peerdestAdd
- - the Location of our peercInput
- - Input channel to be used for data communicationscOuput
- - output channel to be used for data communicationspublic SignalConnection Dial(Location peerLoc, SignalConnectionObserver sco) throws DataException, DesktopSignalingException
peerLoc
- - the Location of our peersco
- the SignalConnectionObserver object that is used by the
application to control the dial processpublic SignalConnection Dial(Location peerLoc, Channel cInput, Channel cOutput, SignalConnectionObserver sco) throws DataException, DesktopSignalingException
peerLoc
- - the Location of our peercInput
- - Input channel to be used for data communicationscOutput
- - Output channel to be used for data communicationssco
- the SignalConnectionObserver object that is used by the
application to control the dial processpublic void Hangup(SignalConnection sc) throws ConnectException
sc
- the SignalConnection to hanguppublic void sendDTMF(java.lang.String s, SignalConnection sc) throws ConnectException
s
- is the string representation of the DTMF tone.sc
- is the SignalConnection currently in use with the peer application.public boolean isAlive(SignalConnection sc) throws ConnectException
sc
- is the SignalConnection currently in use with the peer application.public DirectoryService getDirectory()
None.
- public LocationList getLocationList(java.lang.String userid) throws DirectoryServiceException
userid
- is the String representation of a user.public void setTimeout(int t)
t
- is the timeout in milliseconds to be used for Sockets.public int getTimeout()
None
- public int getPort()
None
- public java.lang.String getName()
None
- public void logout()
None.
-
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |