@@ -57,7 +57,7 @@ class EMA_ACCESS_API ChannelInformation
57
57
*/
58
58
enum ConnectionType
59
59
{
60
- InitEnum = -1 , /* !< (-1) Channel is not connected */
60
+ Unidentified = -1 , /* !< (-1) Unidentified */
61
61
SocketEnum = 0 , /* !< (0) Channel is a standard TCP socket connection type */
62
62
EncryptedEnum = 1 , /* !< (1) Channel is encrypted */
63
63
HttpEnum = 2 , /* !< (2) Channel is an HTTP connection based tunneling type */
@@ -124,55 +124,55 @@ class EMA_ACCESS_API ChannelInformation
124
124
*/
125
125
void clear ();
126
126
127
- /* * returns the connected component info as a string
127
+ /* * Gets the connected component info as a string
128
128
@return string representation of this object's connected component info
129
129
*/
130
130
const EmaString& getConnectedComponentInfo () const { return _connectedComponentInfo; }
131
131
132
- /* * returns the hostname as a string
132
+ /* * Gets the hostname as a string
133
133
@return string representation of this object's hostname
134
134
\remark see discussion of this class at the top of this file for more information
135
135
*/
136
136
const EmaString& getHostname () const { return _hostname; }
137
137
138
- /* * returns the IP address as a string
138
+ /* * Gets the IP address of the connected client
139
139
@return string representation of this object's IP address
140
140
\remark see discussion of this class at the top of this file for more information.
141
141
\remark this is set only for IProvider applications
142
142
*/
143
143
const EmaString& getIPaddress () const { return _ipAddress; }
144
144
145
- /* * returns the channel state as a ChannelState enum
145
+ /* * Gets the channel state as a ChannelState enum
146
146
@return ChannelState enum representation of this object's channel state
147
147
*/
148
148
ChannelState getChannelState () const { return _channelState; }
149
149
150
- /* * returns the connection type as a ConnectionType enum
150
+ /* * Gets the connection type as a ConnectionType enum
151
151
@return ConnectionType enum representation of this object's connection type
152
152
*/
153
153
ConnectionType getConnectionType () const { return _connectionType; }
154
154
155
- /* * returns the protocol type as a ProtocolType enum
155
+ /* * Gets the protocol type as a ProtocolType enum
156
156
@return ProtocolType enum representation of this object's protocol type
157
157
*/
158
158
ProtocolType getProtocolType () const { return _protocolType; }
159
159
160
- /* * returns the major version as a UInt32
160
+ /* * Gets the major version
161
161
@return UInt32 representation of this object's major version
162
162
*/
163
163
UInt32 getMajorVersion () const { return _majorVersion; }
164
164
165
- /* * returns the minor version as a UInt32
165
+ /* * Gets the minor version
166
166
@return UInt32 representation of this object's minor version
167
167
*/
168
168
UInt32 getMinorVersion () const { return _minorVersion; }
169
169
170
- /* * returns the ping timeout as a UInt32
170
+ /* * Gets the ping timeout
171
171
@return UInt32 representation of this object's ping timeout
172
172
*/
173
173
UInt32 getPingTimeout () const { return _pingTimeout; }
174
174
175
- /* * Returns a string representation of the class instance.
175
+ /* * Gets a string representation of the class instance.
176
176
@return string representation of the class instance.
177
177
*/
178
178
const EmaString& toString () const ;
@@ -193,7 +193,7 @@ class EMA_ACCESS_API ChannelInformation
193
193
*/
194
194
ChannelInformation& hostname (const EmaString& hostname);
195
195
196
- /* * Specifies IP address
196
+ /* * Specifies the IP address of the connected client
197
197
@param[in] ipAddress specifies IP address as a string
198
198
@return reference to this object
199
199
*/
@@ -224,19 +224,19 @@ class EMA_ACCESS_API ChannelInformation
224
224
ChannelInformation& protocolType (ProtocolType protocolType);
225
225
226
226
/* * Specifies major version
227
- @param[in] majorVersion specifies majorVersion as a UInt32
227
+ @param[in] majorVersion specifies majorVersion
228
228
@return reference to this object
229
229
*/
230
230
ChannelInformation& majorVersion (UInt32 majorVersion);
231
231
232
232
/* * Specifies minor version
233
- @param[in] minorVersion specifies minorVersion as a UInt32
233
+ @param[in] minorVersion specifies minorVersion
234
234
@return reference to this object
235
235
*/
236
236
ChannelInformation& minorVersion (UInt32 minorVersion);
237
237
238
238
/* * Specifies ping timeout
239
- @param[in] pingTimeout specifies ping timeout as a UInt32
239
+ @param[in] pingTimeout specifies ping timeout
240
240
@return reference to this object
241
241
*/
242
242
ChannelInformation& pingTimeout (UInt32 pingTimeout);
0 commit comments