Print Page as PDF
gov.va.med.net.SocketManager ICR (5176)

gov.va.med.net.SocketManager    ICR (5176)

Name Value
NUMBER 5176
IA # 5176
DATE CREATED 2008/04/11
CUSTODIAL PACKAGE FOUNDATIONS
USAGE Supported
TYPE Other
DBIC APPROVAL STATUS APPROVED
NAME gov.va.med.net.SocketManager
GENERAL DESCRIPTION
public class SocketManager extends java.lang.Object
implements java.io.Serializable: Represents a socket that can be used to
communicate with IP end points.
STATUS Active
KEYWORDS
  • Foundations
  • FoundationsLib
  • socket
DURATION Till Otherwise Agreed
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
getBufferSize()
public int getBufferSize(): Returns the buffer size
(int).
VARIABLES TYPE VARIABLES DESCRIPTION
return Output
returns int: buffer size.
setBufferSize()
void setBufferSize(int value): Sets the buffer size.
VARIABLES TYPE VARIABLES DESCRIPTION
value Input
int: size to set buffer to.
getSoc()
public java.net.Socket getSoc(): Gets the socket
associated with this SocketManager.
VARIABLES TYPE VARIABLES DESCRIPTION
return Output
returns java.net.Socket: socket associated with this
socket manager.
constructor
public SocketManager(): constructs a Socket Manager
instance.

public SocketManager(java.net.Socket soc): constructs a Socket Manager
instance.
VARIABLES TYPE VARIABLES DESCRIPTION
socket Input
(optional) java.net.Socket: construct the Socket
Manager and set its socket to the specified socket.
setSoc()
void setSoc(java.net.Socket value): Sets the socket
associated with this SocketManager.
VARIABLES TYPE VARIABLES DESCRIPTION
value Input
java.net.Socket: the socket to associate with this
SocketManager.
sendData()
public void sendData(java.lang.String xmlRequest)
throws VistaSocketException:

Writes data to the open socket.
VARIABLES TYPE VARIABLES DESCRIPTION
data Input
java.lang.String: data to write to the open socket.
receiveData()
public java.lang.String receiveData() throws
VistaSocketException, VistaSocketTimeOutException:

Reads the socket for a response and writes to String.
VARIABLES TYPE VARIABLES DESCRIPTION
return Output
returns java.lang.String: return value.
throws Output
throws: gov.va.med.net.VistaSocketException,
gov.va.med.net.VistaSocketTimeOutException.
getMatchingIdentifier()
public java.lang.String getMatchingIdentifier(): Gets
the socket's identifier (if any).
VARIABLES TYPE VARIABLES DESCRIPTION
return Output
returns java.lang.String: socket's identifier.
setMatchingIdentifier()
void setMatchingIdentifier(java.lang.String string):
Sets an identifier to identify the socket.
VARIABLES TYPE VARIABLES DESCRIPTION
string Input
java.lang.String: identifier for socket.
DATE ACTIVATED 2008/07/11