TcpClient
Contents
[
Hide
]TcpClient class
Represents a client for the TCP network services. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument.
class TcpClient : public System::IDisposable
Methods
| Method | Description |
|---|---|
| System::SharedPtr<IAsyncResult> BeginConnect(String, int32_t, AsyncCallback, System::SharedPtr<Object>) | Initiates an asynchronous connect operation. |
| System::SharedPtr<IAsyncResult> BeginConnect(System::SharedPtr<IPAddress>, int32_t, AsyncCallback, System::SharedPtr<Object>) | Initiates an asynchronous connect operation. |
| System::SharedPtr<IAsyncResult> BeginConnect(System::ArrayPtr<System::SharedPtr<IPAddress>>, int32_t, AsyncCallback, System::SharedPtr<Object>) | Initiates an asynchronous connect operation. |
| void Close() | Closes the connection and disposes the current instance. |
| void Connect(String, int32_t) | Establishes a connection to the specified remote host. |
| void Connect(System::SharedPtr<IPAddress>, int32_t) | Establishes a connection to the specified remote host. |
| void Connect(System::SharedPtr<IPEndPoint>) | Establishes a connection to the specified remote host. |
| void Connect(System::ArrayPtr<System::SharedPtr<IPAddress>>, int32_t) | Establishes a connection to the specified remote host. |
| virtual void Dispose() | Does nothing. |
| void EndConnect(System::SharedPtr<IAsyncResult>) | Waits until the specified asynchronous connect operation completes. |
| virtual bool Equals(ptr) | Compares objects using C# Object.Equals semantics. |
| static std::enable_if<IsSmartPtr<T1>::value&&IsSmartPtr<T2>::value, bool>::type Equals(T1 const&, T2 const&) | Compares reference type objects in C# style. |
| static std::enable_if<!IsSmartPtr<T1>::value&&!IsSmartPtr<T2>::value, bool>::type Equals(T1 const&, T2 const&) | Compares value type objects in C# style. |
| static bool Equals(float const&, float const&) | Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. |
| static bool Equals(double const&, double const&) | Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. |
| virtual bool FastCast(const Details::FastRttiBase&, void **) const | For internal purposes only. |
| int32_t get_Available() | Returns the number of bytes that are received and ready to read. |
| System::SharedPtr<Socket> get_Client() | Gets the socket. |
| bool get_Connected() | Returns a value that indicates if the socket is connected to the remote host. |
| bool get_ExclusiveAddressUse() | Gets a value that indicates if the current instance allows only one client to use a port. |
| System::SharedPtr<LingerOption> get_LingerState() | Gets a value that indicates if the socket will delay closing in an attempt to send all pending data. |
| bool get_NoDelay() | Gets a value that indicates if the current instance is using the Nagle algorithm. |
| int32_t get_ReceiveBufferSize() | Gets the size of the buffer that is used for receiving data. |
| int32_t get_ReceiveTimeout() | Gets a value that indicates an amount of time after which data receiving will time out. |
| int32_t get_SendBufferSize() | Gets the size of the buffer that is used for sending data. |
| int32_t get_SendTimeout() | Gets a value that indicates an amount of time after which data sending will time out. |
| Detail::SmartPtrCounter * GetCounter() | Gets reference counter data structure associated with the object. |
| virtual int32_t GetHashCode() const | Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. |
| System::SharedPtr<NetworkStream> GetStream() | Returns the stream that is used for sending and receiving data. |
| virtual const TypeInfo& GetType() const | Gets actual type of object. Analog of C# System.Object.GetType() call. |
| virtual bool Is(const TypeInfo&) const | Check if object represents an instance of type described by targetType. Analog of C# ‘is’ operator. |
| void Lock() | Implements C# lock() statement locking. Call directly or use LockContext sentry object. |
| virtual ptr MemberwiseClone() const | Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. |
| Object() | Creates object. Initializes all internal data structures. |
| Object(Object const&) | Copy constructor. Doesn’t copy anything, really, just initializes new object and enables copy constructing subclasses. |
| Object& operator=(Object const&) | Assignment operator. Doesn’t copy anything, really, just initializes new object and enables copy constructing subclasses. |
| static bool ReferenceEquals(ptr const&, ptr const&) | Compares objects by reference. |
| static std::enable_if<!IsSmartPtr<T>::value, bool>::type ReferenceEquals(T const&, T const&) | Compares objects by reference. |
| static std::enable_if<!IsSmartPtr<T>::value, bool>::type ReferenceEquals(T const&, std::nullptr_t) | Reference-compares value type object with nullptr. |
| bool ReferenceEquals(String const&, std::nullptr_t) | Specialization of Object::ReferenceEquals for case of string and nullptr. |
| bool ReferenceEquals(String const&, String const&) | Specialization of Object::ReferenceEquals for case of strings. |
| int RemovedSharedRefs(int) | Decreases shared reference count by specified value. |
| void set_Client(System::SharedPtr<Socket>) | Sets the socket. |
| void set_ExclusiveAddressUse(bool) | Sets a value that indicates if the current instance allows only one client to use a port. |
| void set_LingerState(System::SharedPtr<LingerOption>) | Sets a value that indicates if the socket will delay closing in an attempt to send all pending data. |
| void set_NoDelay(bool) | Sets a value that indicates if the current instance is using the Nagle algorithm. |
| void set_ReceiveBufferSize(int32_t) | Sets the size of the buffer that is used for receiving data. |
| void set_ReceiveTimeout(int32_t) | Sets a value that indicates an amount of time after which data receiving will time out. |
| void set_SendBufferSize(int32_t) | Sets the size of the buffer that is used for sending data. |
| void set_SendTimeout(int32_t) | Sets a value that indicates an amount of time after which data sending will time out. |
| virtual void SetTemplateWeakPtr(uint32_t) | Set n’th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. |
| int SharedCount() const | Gets current value of shared reference counter. |
| Object * SharedRefAdded() | Increments shared reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector. |
| int SharedRefRemovedSafe() | Decrements and returns shared reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector. |
| TcpClient(System::SharedPtr<IPEndPoint>) | Constructs a new instance. |
| TcpClient() | Constructs a new instance. |
| TcpClient(AddressFamily) | Constructs a new instance. |
| TcpClient(String, int32_t) | Constructs a new instance. |
| virtual String ToString() const | Analog of C# Object.ToString() method. Enables converting custom objects to string. |
| static const TypeInfo& Type() | Implements C# typeof(System.Object) construct. |
| void Unlock() | Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. |
| Detail::SmartPtrCounter * WeakRefAdded() | Increments weak reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector. |
| void WeakRefRemoved() | Decrements weak reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector. |
| virtual ~Object() | Destroys object. Frees all internal data structures. |
| virtual ~TcpClient() | Destructs the current instance. |
See Also
- Class IDisposable
- Namespace System::Net::Sockets
- Library Aspose.Slides