1. Epic GamesDeveloper
  3. FSocketEOS

FSocketEOS

Unreal Engine C++ API Reference > Plugins > SocketSubsystemEOS

Inheritance Hierarchy

References

   
Module SocketSubsystemEOS
Header /Engine/Plugins/Online/SocketSubsystemEOS/Source/SocketSubsystemEOS/Public/SocketEOS.h
Include #include "SocketEOS.h"

Syntax

class FSocketEOS : public FSocket

Constructors

  Type Name Description
Public function  

FSocketEOS ( FSocketSubsystemEOS& SocketSubsystem,
const FString& InSocketDescription
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function bool

Close ( const FInternetAddrEOS& RemoteAddress
)

  
Public function void  
Public function void

SetLocalAddress ( const FInternetAddrEOS& InLocalAddress
)

  
Public function bool

WasClosed ( const FInternetAddrEOS& RemoteAddress
)

  

Overridden from FSocket

  Type Name Description
Public function Virtual FSocket *

Accept ( FInternetAddr& OutAddr,
const FString& InSocketDescription
)

 Accepts a connection that is pending.
Public function Virtual FSocket *

Accept ( const FString& InSocketDescription
)

 Accepts a connection that is pending.
Public function Virtual bool

Bind ( const FInternetAddr& Addr
)

 Binds a socket to a network byte ordered address.
Public function Virtual bool

Close ()

 Closes the socket
Public function Virtual bool

Connect ( const FInternetAddr& Addr
)

 Connects a socket to a network byte ordered address.
Public function Virtual void

GetAddress ( FInternetAddr& OutAddr
)

 Reads the address the socket is bound to and returns it.
Public function Virtual ESocketConnectionState Determines the connection state of the socket.
Public function Virtual bool Reads the address of the peer the socket is connected to.
Public function Virtual int32 Reads the port this socket is bound to.
Public function Virtual bool

HasPendingData ( uint32& PendingDataSize
)

 Queries the socket to determine if there is pending data on the queue.
Public function Virtual bool

JoinMulticastGroup ( const FInternetAddr& GroupAddress,
const FInternetAddr& InterfaceAddress
)

 Joins this socket to the specified multicast group on the specified interface.
Public function Virtual bool

JoinMulticastGroup ( const FInternetAddr& GroupAddress
)

 Joins this socket to the specified multicast group.
Public function Virtual bool

LeaveMulticastGroup ( const FInternetAddr& GroupAddress
)

 Removes this UDP client from the specified multicast group.
Public function Virtual bool

LeaveMulticastGroup ( const FInternetAddr& GroupAddress,
const FInternetAddr& InterfaceAddress
)

 Removes this UDP client from the specified multicast group on the specified interface.
Public function Virtual bool

Listen ( int32 MaxBacklog
)

 Places the socket into a state to listen for incoming connections.
Public function Virtual bool

Recv ( uint8* Data,
int32 BufferSize,
int32& BytesRead,
ESocketReceiveFlags::Type Flags
)

 Reads a chunk of data from a connected socket
Public function Virtual bool

RecvFrom ( uint8* Data,
int32 BufferSize,
int32& BytesRead,
FInternetAddr& Source,
ESocketReceiveFlags::Type Flags
)

 Reads a chunk of data from the socket and gathers the source address.
Public function Virtual bool

Send ( const uint8* Data,
int32 Count,
int32& BytesSent
)

 Sends a buffer on a connected socket.
Public function Virtual bool

SendTo ( const uint8* Data,
int32 Count,
int32& BytesSent,
const FInternetAddr& Destination
)

 Sends a buffer to a network byte ordered address.
Public function Virtual bool

SetBroadcast ( bool bAllowBroadcast
)

 Sets a socket into broadcast mode (UDP only).
Public function Virtual bool

SetLinger ( bool bShouldLinger,
int32 Timeout
)

 Sets whether and how long a socket will linger after closing.
Public function Virtual bool

SetMulticastInterface ( const FInternetAddr& InterfaceAddress
)

 Sets the interface used to send outgoing multicast datagrams.
Public function Virtual bool

SetMulticastLoopback ( bool bLoopback
)

 Enables or disables multicast loopback on the socket (UDP only).
Public function Virtual bool

SetMulticastTtl ( uint8 TimeToLive
)

 Sets the time to live (TTL) for multicast datagrams.
Public function Virtual bool

SetNoDelay ( bool bIsNoDelay
)

 Sets this socket into TCP_NODELAY mode (TCP only).
Public function Virtual bool

SetNonBlocking ( bool bIsNonBlocking
)

 Sets this socket into non-blocking mode.
Public function Virtual bool

SetReceiveBufferSize ( int32 Size,
int32& NewSize
)

 Sets the size of the receive buffer to use.
Public function Virtual bool

SetRecvErr ( bool bUseErrorQueue
)

 Enables error queue support for the socket.
Public function Virtual bool

SetReuseAddr ( bool bAllowReuse
)

 Sets whether a socket can be bound to an address in use.
Public function Virtual bool

SetSendBufferSize ( int32 Size,
int32& NewSize
)

 Sets the size of the send buffer to use.
Public function Virtual bool

Shutdown ( ESocketShutdownMode Mode
)

 Shuts down the socket, making it unusable for reads and/or writes.
Public function Virtual bool

Wait ( ESocketWaitConditions::Type Condition,
FTimespan WaitTime
)

 Blocks until the specified condition is met.
Public function Virtual bool

WaitForPendingConnection ( bool& bHasPendingConnection,
const FTimespan& WaitTime
)

 Waits for a pending connection on the socket.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page