className
stringlengths 1
167
| headerPath
stringlengths 14
166
| description
stringlengths 0
1.62k
| module
stringlengths 0
76
| code
stringlengths 0
11.4k
| variables
listlengths 0
395
|
|---|---|---|---|---|---|
FSocket::Accept | /Engine/Source/Runtime/Sockets/Public/Sockets.h | Accepts a connection that is pending.
The new (heap-allocated) socket, or nullptr if unsuccessful. | Sockets | [FSocket](API\Runtime\Sockets\FSocket) * Accept ( [FInternetAddr](API\Runtime\Sockets\FInternetAddr) & OutAddr, const [FString](API\Runtime\Core\Containers\FString) & InSocketDescription ) | [] |
FSocket::Bind | /Engine/Source/Runtime/Sockets/Public/Sockets.h | Binds a socket to a network byte ordered address.
true if successful, false otherwise. | Sockets | bool Bind ( const [FInternetAddr](API\Runtime\Sockets\FInternetAddr) & Addr ) | [] |
FSocket::Close | /Engine/Source/Runtime/Sockets/Public/Sockets.h | Closes the socket
true if it closes without errors, false otherwise. | Sockets | bool Close() | [] |
FSocket::Connect | /Engine/Source/Runtime/Sockets/Public/Sockets.h | Connects a socket to a network byte ordered address.
true if successful, false otherwise. | Sockets | bool Connect ( const [FInternetAddr](API\Runtime\Sockets\FInternetAddr) & Addr ) | [] |
FSocket::GetAddress | /Engine/Source/Runtime/Sockets/Public/Sockets.h | Reads the address the socket is bound to and returns it. | Sockets | void GetAddress ( [FInternetAddr](API\Runtime\Sockets\FInternetAddr) & OutAddr ) | [] |
FSocket::GetConnectionState | /Engine/Source/Runtime/Sockets/Public/Sockets.h | Determines the connection state of the socket.
Connection state. | Sockets | ESocketConnectionState GetConnectionState() | [] |
FSocket::GetDescription | /Engine/Source/Runtime/Sockets/Public/Sockets.h | GetSocketType | Sockets | [FString](API\Runtime\Core\Containers\FString) GetDescription() const | [] |
FSocket::GetPeerAddress | /Engine/Source/Runtime/Sockets/Public/Sockets.h | Reads the address of the peer the socket is connected to.
true if the address was retrieved correctly, false otherwise. | Sockets | bool GetPeerAddress ( [FInternetAddr](API\Runtime\Sockets\FInternetAddr) & OutAddr ) | [] |
FSocket::GetPortNo | /Engine/Source/Runtime/Sockets/Public/Sockets.h | GetDescription | Sockets | int32 GetPortNo() | [] |
FSocket::GetProtocol | /Engine/Source/Runtime/Sockets/Public/Sockets.h | GetPortNo | Sockets | [FName](API\Runtime\Core\UObject\FName) GetProtocol() const | [] |
FSocket::GetSocketType | /Engine/Source/Runtime/Sockets/Public/Sockets.h | GetPortNo | Sockets | ESocketType GetSocketType() const | [] |
FSocket::HasPendingConnection | /Engine/Source/Runtime/Sockets/Public/Sockets.h | Queries the socket to determine if there is a pending connection.
true if successful, false otherwise. | Sockets | bool HasPendingConnection ( bool & bHasPendingConnection ) | [] |
FSocket::HasPendingData | /Engine/Source/Runtime/Sockets/Public/Sockets.h | Queries the socket to determine if there is pending data on the queue.
true if the socket has data, false otherwise. | Sockets | bool HasPendingData ( uint32 & PendingDataSize ) | [] |
FSocket::JoinMulticastGroup | /Engine/Source/Runtime/Sockets/Public/Sockets.h | SetMulticastTtl | Sockets | bool JoinMulticastGroup ( const [FInternetAddr](API\Runtime\Sockets\FInternetAddr) & GroupAddress ) | [] |
FSocket::JoinMulticastGroup | /Engine/Source/Runtime/Sockets/Public/Sockets.h | SetMulticastTtl | Sockets | bool JoinMulticastGroup ( const [FInternetAddr](API\Runtime\Sockets\FInternetAddr) & GroupAddress, const [FInternetAddr](API\Runtime\Sockets\FInternetAddr) & InterfaceAddress ) | [] |
FSocket::LeaveMulticastGroup | /Engine/Source/Runtime/Sockets/Public/Sockets.h | SetMulticastTtl | Sockets | bool LeaveMulticastGroup ( const [FInternetAddr](API\Runtime\Sockets\FInternetAddr) & GroupAddress ) | [] |
FSocket::LeaveMulticastGroup | /Engine/Source/Runtime/Sockets/Public/Sockets.h | SetMulticastTtl | Sockets | bool LeaveMulticastGroup ( const [FInternetAddr](API\Runtime\Sockets\FInternetAddr) & GroupAddress, const [FInternetAddr](API\Runtime\Sockets\FInternetAddr) & InterfaceAddress ) | [] |
FSocket::Listen | /Engine/Source/Runtime/Sockets/Public/Sockets.h | Places the socket into a state to listen for incoming connections.
true if successful, false otherwise. | Sockets | bool Listen ( int32 MaxBacklog ) | [] |
FSocket::Recv | /Engine/Source/Runtime/Sockets/Public/Sockets.h | A return value of 'true' does not necessarily mean that data was returned. Callers must check the 'BytesRead' parameter for the actual amount of data returned. A value of zero indicates that there was no data available for reading.
true on success, false in case of a closed socket or an unrecoverable error. | Sockets | virtual bool Recv ( uint8 * Data, int32 BufferSize, int32 & BytesRead, [ESocketReceiveFlags::Type](API\Runtime\Sockets\ESocketReceiveFlags__Type) Flags ) | [] |
FSocket::RecvFrom | /Engine/Source/Runtime/Sockets/Public/Sockets.h | A return value of 'true' does not necessarily mean that data was returned. Callers must check the 'BytesRead' parameter for the actual amount of data returned. A value of zero indicates that there was no data available for reading.
true on success, false in case of a closed socket or an unrecoverable error. | Sockets | virtual bool RecvFrom ( uint8 * Data, int32 BufferSize, int32 & BytesRead, [FInternetAddr](API\Runtime\Sockets\FInternetAddr) & Source, [ESocketReceiveFlags::Type](API\Runtime\Sockets\ESocketReceiveFlags__Type) Flags ) | [] |
FSocket::RecvFromWithPktInfo | /Engine/Source/Runtime/Sockets/Public/Sockets.h | A return value of 'true' does not necessarily mean that data was returned. Callers must check the 'BytesRead' parameter for the actual amount of data returned. A value of zero indicates that there was no data available for reading.
true on success, false in case of a closed socket or an unrecoverable error. | Sockets | virtual bool RecvFromWithPktInfo ( uint8 * Data, int32 BufferSize, int32 & BytesRead, [FInternetAddr](API\Runtime\Sockets\FInternetAddr) & Source, [FInternetAddr](API\Runtime\Sockets\FInternetAddr) & Destination, [ESocketReceiveFlags::Type](API\Runtime\Sockets\ESocketReceiveFlags__Type) Flags ) | [] |
FSocket::Send | /Engine/Source/Runtime/Sockets/Public/Sockets.h | Sends a buffer on a connected socket. | Sockets | virtual bool Send ( const uint8 * Data, int32 Count, int32 & BytesSent ) | [] |
FSocket::RecvMulti | /Engine/Source/Runtime/Sockets/Public/Sockets.h | Reads multiple packets from the socket at once, gathering the source address and other optional platform specific data. UseISocketSubsystem::IsSocketRecvMultiSupportedto check if the current socket platform supports this. NOTE: For optimal performance, oneFRecvMultiinstance should be used, for the lifetime of the socket.
Whether or not data was successfully received | Sockets | virtual bool RecvMulti ( [FRecvMulti](API\Runtime\Sockets\FRecvMulti) & MultiData, [ESocketReceiveFlags::Type](API\Runtime\Sockets\ESocketReceiveFlags__Type) Flags ) | [] |
FSocket::SendTo | /Engine/Source/Runtime/Sockets/Public/Sockets.h | Sends a buffer to a network byte ordered address. | Sockets | virtual bool SendTo ( const uint8 * Data, int32 Count, int32 & BytesSent, const [FInternetAddr](API\Runtime\Sockets\FInternetAddr) & Destination ) | [] |
FSocket::SetBroadcast | /Engine/Source/Runtime/Sockets/Public/Sockets.h | Sets a socket into broadcast mode (UDP only).
true if successful, false otherwise. | Sockets | bool SetBroadcast ( bool bAllowBroadcast ) | [] |
FSocket::SetIpPktInfo | /Engine/Source/Runtime/Sockets/Public/Sockets.h | Sets whether to enable IP_PKTINFO support
True if the call succeeded, false otherwise. | Sockets | virtual bool SetIpPktInfo ( bool bEnable ) | [] |
FSocket::SetLinger | /Engine/Source/Runtime/Sockets/Public/Sockets.h | Sets whether and how long a socket will linger after closing.
true if the call succeeded, false otherwise. | Sockets | bool SetLinger ( bool bShouldLinger, int32 Timeout ) | [] |
FSocket::SetMulticastInterface | /Engine/Source/Runtime/Sockets/Public/Sockets.h | Multicast traffic is sent using the default interface, this allows to explicitly set the interface used to send outgoing multicast datagrams.
true if the call succeeded, false otherwise. | Sockets | bool SetMulticastInterface ( const [FInternetAddr](API\Runtime\Sockets\FInternetAddr) & InterfaceAddress ) | [] |
FSocket::SetMulticastLoopback | /Engine/Source/Runtime/Sockets/Public/Sockets.h | SetMulticastTtl | Sockets | bool SetMulticastLoopback ( bool bLoopback ) | [] |
FSocket::SetMulticastTtl | /Engine/Source/Runtime/Sockets/Public/Sockets.h | SetMulticastLoopback | Sockets | bool SetMulticastTtl ( uint8 TimeToLive ) | [] |
FSocket::SetNoDelay | /Engine/Source/Runtime/Sockets/Public/Sockets.h | Sets this socket into TCP_NODELAY mode (TCP only).
true if successful, false otherwise. | Sockets | bool SetNoDelay ( bool bIsNoDelay ) | [] |
FSocket::SetNonBlocking | /Engine/Source/Runtime/Sockets/Public/Sockets.h | Sets this socket into non-blocking mode.
true if successful, false otherwise. | Sockets | bool SetNonBlocking ( bool bIsNonBlocking ) | [] |
FSocket::SetReceiveBufferSize | /Engine/Source/Runtime/Sockets/Public/Sockets.h | Sets the size of the receive buffer to use.
true if the call succeeded, false otherwise. | Sockets | bool SetReceiveBufferSize ( int32 Size, int32 & NewSize ) | [] |
FSocket::SetRecvErr | /Engine/Source/Runtime/Sockets/Public/Sockets.h | Enables error queue support for the socket.
true if the call succeeded, false otherwise. | Sockets | bool SetRecvErr ( bool bUseErrorQueue ) | [] |
FSocket::SetRetrieveTimestamp | /Engine/Source/Runtime/Sockets/Public/Sockets.h | Sets whether to retrieve the system-level receive timestamp, for sockets
True if the call succeeded, false otherwise. | Sockets | virtual bool SetRetrieveTimestamp ( bool bRetrieveTimestamp ) | [] |
FSocket::SetReuseAddr | /Engine/Source/Runtime/Sockets/Public/Sockets.h | Sets whether a socket can be bound to an address in use.
true if the call succeeded, false otherwise. | Sockets | bool SetReuseAddr ( bool bAllowReuse ) | [] |
FSocket::SetSendBufferSize | /Engine/Source/Runtime/Sockets/Public/Sockets.h | Sets the size of the send buffer to use.
true if the call succeeded, false otherwise. | Sockets | bool SetSendBufferSize ( int32 Size, int32 & NewSize ) | [] |
FSocket::Shutdown | /Engine/Source/Runtime/Sockets/Public/Sockets.h | Shuts down the socket, making it unusable for reads and/or writes. This does not close the socket!
true if successful, false otherwise. | Sockets | bool Shutdown ( ESocketShutdownMode Mode ) | [] |
FSocket::Wait | /Engine/Source/Runtime/Sockets/Public/Sockets.h | Blocks until the specified condition is met.
true if the condition was met, false if the time limit expired or an error occurred. | Sockets | bool Wait ( [ESocketWaitConditions::Type](API\Runtime\Sockets\ESocketWaitConditions__Type) Condition, [FTimespan](API\Runtime\Core\Misc\FTimespan) WaitTime ) | [] |
FSocket::WaitForPendingConnection | /Engine/Source/Runtime/Sockets/Public/Sockets.h | Waits for a pending connection on the socket.
true if successful, false otherwise. | Sockets | bool WaitForPendingConnection ( bool & bHasPendingConnection, const [FTimespan](API\Runtime\Core\Misc\FTimespan) & WaitTime ) | [] |
FSocket::FSocket | /Engine/Source/Runtime/Sockets/Public/Sockets.h | Default constructor. | Sockets | FSocket() | [] |
FSocket::FSocket | /Engine/Source/Runtime/Sockets/Public/Sockets.h | Specifies the type of socket being created | Sockets | FSocket ( ESocketType InSocketType, const [FString](API\Runtime\Core\Containers\FString) & InSocketDescription ) | [] |
FSocket::FSocket | /Engine/Source/Runtime/Sockets/Public/Sockets.h | Deprecated* Please migrate to the constructor that takes anFNamefor the protocol stack | Sockets | FSocket ( ESocketType InSocketType, const [FString](API\Runtime\Core\Containers\FString) & InSocketDescription, ESocketProtocolFamily InSocketProtocol ) | [] |
FSocket::FSocket | /Engine/Source/Runtime/Sockets/Public/Sockets.h | Specifies the type of socket being created | Sockets | FSocket ( ESocketType InSocketType, const [FString](API\Runtime\Core\Containers\FString) & InSocketDescription, const [FName](API\Runtime\Core\UObject\FName) & InSocketProtocol ) | [] |
FSocket::~FSocket | /Engine/Source/Runtime/Sockets/Public/Sockets.h | Virtual destructor. | Sockets | virtual ~FSocket() | [] |
FSocket | /Engine/Source/Runtime/Sockets/Public/Sockets.h | This is our abstract base class that hides the platform specific socket implementation | Sockets | class FSocket | [
{
"type": "FString",
"name": "SocketDescription",
"description": "Debug description of socket usage."
},
{
"type": "FName",
"name": "SocketProtocol",
"description": "Protocol used in creation of a socket"
},
{
"type": "const ESocketTy...",
"name": "SocketType",
"description": "Indicates the type of socket this is"
}
] |
FSocketDeleter::operator() | /Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h | Sockets | void operator() ( [FSocket](API\Runtime\Sockets\FSocket) * Socket ) const | [] |
|
FSocketDeleter::FSocketDeleter | /Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h | Sockets | FSocketDeleter() | [] |
|
FSocketDeleter::FSocketDeleter | /Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h | Sockets | FSocketDeleter ( [ISocketSubsystem](API\Runtime\Sockets\ISocketSubsystem) * InSubsystem ) | [] |
|
FSocketSubsystemModule::GetSocketSubsystem | /Engine/Source/Runtime/Sockets/Public/SocketSubsystemModule.h | Main entry point for accessing a socket subsystem by name Will load the appropriate module if the subsystem isn't currently loaded It's possible that the subsystem doesn't exist and therefore can return NULL
Requested socket subsystem, or NULL if that subsystem was unable to load or doesn't exist | Sockets | virtual [ISocketSubsystem](API\Runtime\Sockets\ISocketSubsystem) * GetSocketSubsystem ( const [FName](API\Runtime\Core\UObject\FName) InSubsystemName ) | [] |
FSocketSubsystemModule::RegisterSocketSubsystem | /Engine/Source/Runtime/Sockets/Public/SocketSubsystemModule.h | Register a new socket subsystem interface with the base level factory provider | Sockets | virtual void RegisterSocketSubsystem ( const [FName](API\Runtime\Core\UObject\FName) FactoryName, class [ISocketSubsystem](API\Runtime\Sockets\ISocketSubsystem) * Factory, bool bMakeDefault ) | [] |
FSocketSubsystemModule::StartupModule | /Engine/Source/Runtime/Sockets/Public/SocketSubsystemModule.h | Called right after the module DLL has been loaded and the module object has been created Overloaded to allow the default subsystem a chance to load | Sockets | virtual void StartupModule() | [] |
FSocketSubsystemModule::ShutdownModule | /Engine/Source/Runtime/Sockets/Public/SocketSubsystemModule.h | Called before the module is unloaded, right before the module object is destroyed. Overloaded to shut down all loaded online subsystems | Sockets | virtual void ShutdownModule() | [] |
FSocketSubsystemModule::SupportsAutomaticShutdown | /Engine/Source/Runtime/Sockets/Public/SocketSubsystemModule.h | Override this to set whether your module would like cleanup on application shutdown
Whether the module supports shutdown on application exit | Sockets | virtual bool SupportsAutomaticShutdown() | [] |
FSocketSubsystemModule::SupportsDynamicReloading | /Engine/Source/Runtime/Sockets/Public/SocketSubsystemModule.h | Override this to set whether your module is allowed to be unloaded on the fly
Whether the module supports shutdown separate from the rest of the engine. | Sockets | virtual bool SupportsDynamicReloading() | [] |
FSocketSubsystemModule::UnregisterSocketSubsystem | /Engine/Source/Runtime/Sockets/Public/SocketSubsystemModule.h | Unregister an existing online subsystem interface from the base level factory provider | Sockets | virtual void UnregisterSocketSubsystem ( const [FName](API\Runtime\Core\UObject\FName) FactoryName ) | [] |
FSocketDeleter | /Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h | Deleter object that can be used with unique & shared pointers that store FSockets. The SocketSubsystem must be valid when the call operator is invoked! | Sockets | class FSocketDeleter | [] |
FSocketSubsystemModule::FSocketSubsystemModule | /Engine/Source/Runtime/Sockets/Public/SocketSubsystemModule.h | Sockets | FSocketSubsystemModule() | [] |
|
FSocketSubsystemModule::~FSocketSubsystemModule | /Engine/Source/Runtime/Sockets/Public/SocketSubsystemModule.h | Sockets | virtual ~FSocketSubsystemModule() | [] |
|
FSocketSubsystemModule | /Engine/Source/Runtime/Sockets/Public/SocketSubsystemModule.h | Socket subsystem module class Wraps the loading of an socket subsystem by name and allows new services to register themselves for use | Sockets | class FSocketSubsystemModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface) | [] |
ISocketSubsystem::AddHostNameToCache | /Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h | Stores the ip address with the matching host name | Sockets | void AddHostNameToCache ( const ANSICHAR * HostName, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [FInternetAddr](API\Runtime\Sockets\FInternetAddr) > Addr ) | [] |
ISocketSubsystem::BindNextPort | /Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h | Bind to next available port.
The bound port number, or 0 on failure | Sockets | int32 BindNextPort ( [FSocket](API\Runtime\Sockets\FSocket) * Socket, [FInternetAddr](API\Runtime\Sockets\FInternetAddr) & Addr, int32 PortCount, int32 PortIncrement ) | [] |
ISocketSubsystem::CreateInternetAddr | /Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h | Create a properFInternetAddrrepresentation | Sockets | [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FInternetAddr](API\Runtime\Sockets\FInternetAddr) > CreateInternetAddr() | [] |
ISocketSubsystem::CreateInternetAddr | /Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h | Create aFInternetAddrof the desired protocol | Sockets | virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FInternetAddr](API\Runtime\Sockets\FInternetAddr) > CreateInternetAddr ( const [FName](API\Runtime\Core\UObject\FName) ProtocolType ) | [] |
ISocketSubsystem::CreateInternetAddr | /Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h | Create a properFInternetAddrrepresentation | Sockets | virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FInternetAddr](API\Runtime\Sockets\FInternetAddr) > CreateInternetAddr ( uint32 Address, uint32 Port ) | [] |
ISocketSubsystem::CreateRecvMulti | /Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h | Create a platform specificFRecvMultirepresentation
Returns the platform specificFRecvMultiinstance | Sockets | virtual [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [FRecvMulti](API\Runtime\Sockets\FRecvMulti) > CreateRecvMulti ( int32 MaxNumPackets, int32 MaxPacketSize, ERecvMultiFlags Flags ) | [] |
ISocketSubsystem::CreateResolveInfoCached | /Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h | Addr address to resolve for the socket subsystem
the new resolved address or NULL if failed | Sockets | virtual [FResolveInfoCached](API\Runtime\Sockets\FResolveInfoCached) * CreateResolveInfoCached ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FInternetAddr](API\Runtime\Sockets\FInternetAddr) > Addr ) const | [] |
ISocketSubsystem::CreateSocket | /Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h | SocketType type of socket to create (DGram, Stream, etc)
the new socket or NULL if failed | Sockets | virtual [FSocket](API\Runtime\Sockets\FSocket) * CreateSocket ( const [FName](API\Runtime\Core\UObject\FName) & SocketType, const [FString](API\Runtime\Core\Containers\FString) & SocketDescription, ESocketProtocolFamily ProtocolType ) | [] |
ISocketSubsystem::CreateSocket | /Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h | SocketType type of socket to create (DGram, Stream, etc)
the new socket or NULL if failed | Sockets | virtual [FSocket](API\Runtime\Sockets\FSocket) * CreateSocket ( const [FName](API\Runtime\Core\UObject\FName) & SocketType, const [FString](API\Runtime\Core\Containers\FString) & SocketDescription, bool bForceUDP ) | [] |
ISocketSubsystem::CreateSocket | /Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h | SocketType type of socket to create (DGram, Stream, etc)
the new socket or NULL if failed | Sockets | [FSocket](API\Runtime\Sockets\FSocket) * CreateSocket ( const [FName](API\Runtime\Core\UObject\FName) & SocketType, const [FString](API\Runtime\Core\Containers\FString) & SocketDescription, const [FName](API\Runtime\Core\UObject\FName) & ProtocolName ) | [] |
ISocketSubsystem::CreateUniqueSocket | /Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h | SocketType type of socket to create (DGram, Stream, etc)
the new socket or NULL if failed | Sockets | FUniqueSocket CreateUniqueSocket ( const [FName](API\Runtime\Core\UObject\FName) & SocketType, const [FString](API\Runtime\Core\Containers\FString) & SocketDescription, bool bForceUDP ) | [] |
ISocketSubsystem::CreateUniqueSocket | /Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h | SocketType type of socket to create (DGram, Stream, etc)
the new socket or NULL if failed | Sockets | FUniqueSocket CreateUniqueSocket ( const [FName](API\Runtime\Core\UObject\FName) & SocketType, const [FString](API\Runtime\Core\Containers\FString) & SocketDescription, const [FName](API\Runtime\Core\UObject\FName) & ProtocolName ) | [] |
ISocketSubsystem::DestroySocket | /Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h | Cleans up a socket class | Sockets | void DestroySocket ( [FSocket](API\Runtime\Sockets\FSocket) * Socket ) | [] |
ISocketSubsystem::Get | /Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h | Get the singleton socket subsystem for the given named subsystem | Sockets | static [ISocketSubsystem](API\Runtime\Sockets\ISocketSubsystem) * Get ( const [FName](API\Runtime\Core\UObject\FName) & SubsystemName ) | [] |
ISocketSubsystem::GetAddressFromString | /Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h | This is a what you see is what you get, there is no DNS resolution of the input string, so only use this if you know you already have a valid address and will not need to convert. Otherwise, feed the address to GetAddressInfo for guaranteed results.
TheFInternetAddrof the given string address. This will point to nullptr on failure. | Sockets | [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FInternetAddr](API\Runtime\Sockets\FInternetAddr) > GetAddressFromString ( const [FString](API\Runtime\Core\Containers\FString) & InAddress ) | [] |
ISocketSubsystem::GetAddressInfo | /Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h | Gets the address information of the given hostname and outputs it into an array of resolvable addresses. It is up to the caller to determine which one is valid for their environment.
the results structure containing the array of address results to this query | Sockets | virtual [FAddressInfoResult](API\Runtime\Sockets\FAddressInfoResult) GetAddressInfo ( const TCHAR * HostName, const TCHAR * ServiceName, EAddressInfoFlags QueryFlags, ESocketProtocolFamily ProtocolType, ESocketType SocketType ) | [] |
ISocketSubsystem::GetAddressInfo | /Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h | This function allows for specifying FNames for the protocol type, allowing for support of other platform protocols
the results structure containing the array of address results to this query | Sockets | [FAddressInfoResult](API\Runtime\Sockets\FAddressInfoResult) GetAddressInfo ( const TCHAR * HostName, const TCHAR * ServiceName, EAddressInfoFlags QueryFlags, const [FName](API\Runtime\Core\UObject\FName) ProtocolTypeName, ESocketType SocketType ) | [] |
ISocketSubsystem::GetAddressInfoAsync | /Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h | This function allows for specifying FNames for the protocol type, allowing for support of other platform protocols | Sockets | virtual void GetAddressInfoAsync ( FAsyncGetAddressInfoCallback Callback, const TCHAR * HostName, const TCHAR * ServiceName, EAddressInfoFlags QueryFlags, const [FName](API\Runtime\Core\UObject\FName) ProtocolTypeName, ESocketType SocketType ) | [] |
ISocketSubsystem::GetHostByName | /Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h | Creates a platform specific async hostname resolution object
the resolve info to query for the address | Sockets | virtual [FResolveInfo](API\Runtime\Sockets\FResolveInfo) * GetHostByName ( const ANSICHAR * HostName ) | [] |
ISocketSubsystem::GetHostName | /Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h | Determines the name of the local machine
true if successful, false otherwise | Sockets | bool GetHostName ( [FString](API\Runtime\Core\Containers\FString) & HostName ) | [] |
ISocketSubsystem::GetHostByNameFromCache | /Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h | Checks the host name cache for an existing entry (faster than resolving again)
true if the host was found, false otherwise | Sockets | bool GetHostByNameFromCache ( const ANSICHAR * HostName, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [FInternetAddr](API\Runtime\Sockets\FInternetAddr) > & Addr ) | [] |
ISocketSubsystem::GetLastErrorCode | /Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h | Returns the last error that has happened | Sockets | ESocketErrors GetLastErrorCode() | [] |
ISocketSubsystem::GetLocalAdapterAddresses | /Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h | Gets the list of addresses associated with the adapters on the local computer. Unlike GetLocalHostAddr, this function does not give preferential treatment to multihome options in results. It's encouraged that users check for multihome before using the results of this function.
true on success, false otherwise. | Sockets | virtual bool GetLocalAdapterAddresses ( [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FInternetAddr](API\Runtime\Sockets\FInternetAddr) >> & OutAddresses ) | [] |
ISocketSubsystem::GetLocalBindAddr | /Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h | Typically, it is better to use GetLocalBindAddresses as it better supports hybrid network functionality and less chances for connections to fail due to mismatched protocols. | Sockets | virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FInternetAddr](API\Runtime\Sockets\FInternetAddr) > GetLocalBindAddr ( [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) & Out ) | [] |
ISocketSubsystem::GetLocalBindAddresses | /Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h | Get bindable addresses that this machine can use as reported by GetAddressInfo with the BindableAddress flag. This will return the various any address for usage. If multihome has been specified, only the multihome address will be returned in the array.
If GetAddressInfo succeeded or multihome is specified, an array of addresses that can be binded on. Failure returns an empty array. | Sockets | virtual [TArray](API\Runtime\Core\Containers\TArray)< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FInternetAddr](API\Runtime\Sockets\FInternetAddr) > > GetLocalBindAddresses() | [] |
ISocketSubsystem::GetMultihomeAddress | /Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h | Returns the multihome address if the flag is present and valid. For ease of use, this function will check validity of the address for the caller.
If the multihome address was set and valid | Sockets | virtual bool GetMultihomeAddress ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FInternetAddr](API\Runtime\Sockets\FInternetAddr) > & Addr ) | [] |
ISocketSubsystem::GetLocalHostAddr | /Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h | To better support multiple network interfaces and remove ambiguity between address protocols, it is encouraged to use GetLocalAdapterAddresses to determine machine addresses. Be sure to check GetMultihomeAddress ahead of time.
The local host address | Sockets | virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FInternetAddr](API\Runtime\Sockets\FInternetAddr) > GetLocalHostAddr ( [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) & Out, bool & bCanBindAll ) | [] |
ISocketSubsystem::GetProtocolFamilyFromName | /Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h | Conversion functions from the SocketProtocolFamily enum to the newFNamesystem. For now, both are supported, but it's better to use theFNamewhen possible. | Sockets | virtual ESocketProtocolFamily GetProtocolFamilyFromName ( const [FName](API\Runtime\Core\UObject\FName) & InProtocolName ) const | [] |
ISocketSubsystem::GetHostByName | /Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h | Does a DNS look up of a host name This code assumes a lot, and as such, it's not guaranteed that the results provided by it are correct. | Sockets | virtual ESocketErrors GetHostByName ( const ANSICHAR * HostName, [FInternetAddr](API\Runtime\Sockets\FInternetAddr) & OutAddr ) | [] |
ISocketSubsystem::GetProtocolNameFromFamily | /Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h | Sockets | virtual [FName](API\Runtime\Core\UObject\FName) GetProtocolNameFromFamily ( ESocketProtocolFamily InProtocolFamily ) const | [] |
|
ISocketSubsystem::GetSocketError | /Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h | Returns a human readable string from an error code | Sockets | const TCHAR * GetSocketError ( ESocketErrors Code ) | [] |
ISocketSubsystem::HasNetworkDevice | /Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h | Whether the machine has a properly configured network device or not | Sockets | bool HasNetworkDevice() | [] |
ISocketSubsystem::GetSocketAPIName | /Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h | Get the name of the socket subsystem
a string naming this subsystem | Sockets | const TCHAR * GetSocketAPIName() const | [] |
ISocketSubsystem::Init | /Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h | Does per platform initialization of the sockets library
true if initialized ok, false otherwise | Sockets | bool Init ( [FString](API\Runtime\Core\Containers\FString) & Error ) | [] |
ISocketSubsystem::IsRecvFromWithPktInfoSupported | /Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h | Returns true ifFSocket::RecvFromWithPktInfois supported by this socket subsystem. | Sockets | virtual bool IsRecvFromWithPktInfoSupported() const | [] |
ISocketSubsystem::IsSocketRecvMultiSupported | /Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h | Returns true ifFSocket::RecvMultiis supported by this socket subsystem | Sockets | virtual bool IsSocketRecvMultiSupported() const | [] |
ISocketSubsystem::IsSocketWaitSupported | /Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h | Returns true ifFSocket::Waitis supported by this socket subsystem. | Sockets | bool IsSocketWaitSupported() const | [] |
ISocketSubsystem::RemoveHostNameFromCache | /Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h | Removes the host name to ip mapping from the cache | Sockets | void RemoveHostNameFromCache ( const ANSICHAR * HostName ) | [] |
ISocketSubsystem::RequiresChatDataBeSeparate | /Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h | Some platforms require chat data (voice, text, etc.) to be placed into packets in a special way. This function tells the net connection whether this is required for this platform | Sockets | bool RequiresChatDataBeSeparate() | [] |
ISocketSubsystem::RequiresEncryptedPackets | /Engine/Source/Runtime/Sockets/Public/SocketSubsystem.h | Some platforms require packets be encrypted. This function tells the net connection whether this is required for this platform | Sockets | bool RequiresEncryptedPackets() | [] |
Subsets and Splits
No saved queries yet
Save your SQL queries to embed, download, and access them later. Queries will appear here once saved.