Interface ITcpipSocket2

Description

The ITcpipSocket2 derives from ITcpipSocket and adds more VISA COM I/O properties and methods specific to TCPIP SOCKET resource sessions.

Methods

Close

Closes the resource. Sending the resource's COM object's reference count to zero (and thus destroying the object) also executes a close, but this method may be useful for environments with garbage collection or other facilities that make object lifetimes non-deterministic.

Flush

Manually flushes the read and write buffers associated with TCPIP SOCKET interfaces.

GetAttribute

Use of this method is discouraged. All the non-deprecated standard attributes are accessible via properties on the appropriate COM interfaces.

Init

Opens the resource. This is the first method on IVisaSession or any of its derived interfaces to be called. In general, you will not call this method because you will use the Resource Manager to create resources.

LockRsrc

Locks the resource.

SetAttribute

Use of this method is discouraged. All the non-deprecated standard attributes are accessible via properties on the appropriate COM interfaces.

SetBufferSize

Sets the size of the read and/or write buffer for TCPIP SOCKET communication.  The mask parameter specifies whether the buffer is a read or write buffer:

  • IO_IN_BUF
  • IO_OUT_BUF
  • IO_IN_AND_OUT_BUFS

UnlockRsrc

Unlocks the resource

Properties

Address

The TCPIP address of the device to which the session is connected.  This string is formatted in dot-notation.

ComponentVersion

A numeric version for this component.

HardwareInterfaceName

The name of the hardware interface (GPIB, ASRL, etc.).

HardwareInterfaceNumber

The board number of the hardware interface.

HardwareInterfaceType

The type number of the hardware interface.

HostName

Specifies the host name of the device. If no host name is available, this attribute returns an empty string.

KeepAlive

An application can request that a TCP/IP provider enable the use of keep-alive packets on TCP connections by turning on this attribute.  If a connection is dropped as a result of keep-alives, the error code VI_ERROR_CONN_LOST is returned to current and subsequent I/O calls on the session.

LastStatus

The return value from the last method call on this interface. This property may be useful in Visual Basic, where positive return values, such as warnings and other non-error return values, cannot be retrieved.

See the Return Values page for a list of positive return values.

LockState

The current locking state of the interface.

NoDelay

The Nagle algorithm is disabled when this attribute is enabled (and vice versa). The Nagle algorithm improves network performance by buffering send data until a full-size packet can be sent.  This attribute is enabled by default in VISA to verify that synchronous writes get flushed immediately.

OptionString

The option string corresponding to the current state of the resource.

Port

Specifies the port number for a given TCPIP address. For a TCPIP SOCKET resource, this is a required part of the address string.

ProgID

The programmatic ID that can be used by COM to create this object.

ResourceName

The VISA resource name of the currently open resource. This name is the canonical version of the resource name and therefore may vary from the resource string used to open/init the resource.

ServerCertificate

Returns the full text of the server certificate in the RFC 5652 PEM format.

ServerCertificateExpirationDate

Returns the expiration date of the server certificate.

ServerCertificateIsPerpetual

Returns a value indicating whether the server certificate is perpetual or not.

ServerCertificateIssuerName

Returns the expiration date of the server certificate.

ServerCertificateSubjectName

Returns the subject name of the server certificate.

SessionType

The session type string, such as "INSTR" or "INTFC".

SoftwareManufacturerID

The ID number of the vendor of this software component.

SoftwareManufacturerName

The name of the vendor of this software component.

SpecVersion

The VISA-defined version information for the specification version to which this component complies.

Timeout

The I/O timeout in milliseconds for I/O communication on this resource session.

TlsCipherSuite

Returns the TLS cipher suite used by the connection.