1. Epic GamesDeveloper
  3. FSocketSubsystemEOS

FSocketSubsystemEOS

Unreal Engine C++ API Reference > Plugins > SocketSubsystemEOS

Inheritance Hierarchy

References

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

Syntax

class FSocketSubsystemEOS : public ISocketSubsystem

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function bool

BindChannel ( const FInternetAddrEOS& Address
)

 Bind our socket name & channel and ensure no other connections are using this combination
Public function TSharedRef< FInternetAddr >

GetLocalBindAddr ( const UWorld*const OwningWorld,
FOutputDevice& Out
)

  
Public function FSocketSubsystemEOS * Returns the FSocketSubsytemEOS instance corresponding with the UWorld* parameter.
Public function void

SetLastSocketError ( const ESocketErrors NewSocketError
)

  
Public function bool

UnbindChannel ( const FInternetAddrEOS& Address
)

 Unbind a previously bound socket name and channel.

Overridden from ISocketSubsystem

  Type Name Description
Public function Virtual TSharedRef< FInternetAddr > Create a proper FInternetAddr representation
Public function Virtual Const FResolveInfoCached * Creates a resolve info cached struct to hold the resolved address
Public function Virtual FSocket *

CreateSocket ( const FName& SocketType,
const FString& SocketDescription,
const FName& ProtocolName
)

 Creates a socket using the given protocol name.
Public function Virtual void

DestroySocket ( FSocket* Socket
)

 Cleans up a socket class
Public function Virtual TSharedPtr< FInternetAddr >

GetAddressFromString ( const FString& InAddress
)

 Serializes a string that only contains an address.
Public function Virtual FAddressInfoResult

GetAddressInfo ( const TCHAR* HostName,
const TCHAR* ServiceName,
EAddressInfoFlags QueryFlags,
const FName ProtocolTypeName,
ESocketType SocketType
)

 Gets the address information of the given hostname and outputs it into an array of resolvable addresses.
Public function Virtual bool

GetHostName ( FString& HostName
)

 Determines the name of the local machine
Public function Virtual ESocketErrors Returns the last error that has happened
Public function Virtual bool Gets the list of addresses associated with the adapters on the local computer.
Public function Virtual TSharedRef< FInternetAddr > Get a local IP to bind to.
Public function Virtual TArray< TSharedRef< FInternetAddr > > Get bindable addresses that this machine can use as reported by GetAddressInfo with the BindableAddress flag.
Public function Virtual Const const TCHAR * Get the name of the socket subsystem
Public function Virtual bool  
Public function Virtual bool

Init ( FString& Error
)

 Does per platform initialization of the sockets library
Public function Virtual Const bool Returns true if FSocket::Wait is supported by this socket subsystem.
Public function Virtual bool Some platforms require chat data (voice, text, etc.) to be placed into packets in a special way.
Public function Virtual bool Some platforms require packets be encrypted.
Public function Virtual void Performs platform specific socket clean up
Public function Virtual ESocketErrors

TranslateErrorCode ( int32 Code
)

 Translates the platform error code to a ESocketErrors enum

Constants

Name Description
SocketSubsystemEOSInstances Static array of all instances of FSocketSubsystemEOS running concurrently (can be more than one in PIE)
SocketSubsystemEOSPerWorldMap Static map of world to corresponding FSocketSubsystemeOS instance

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page