FSocketSubsystemAndroid Class Reference

#include <SocketSubsystemAndroid.h>

Inheritance diagram for FSocketSubsystemAndroid:

Public Member Functions
	FSocketSubsystemAndroid ()
virtual	~FSocketSubsystemAndroid ()
virtual bool	Init (FString &Error) override
virtual void	Shutdown () override
virtual bool	HasNetworkDevice () override
virtual const TCHAR *	GetSocketAPIName () const override
virtual int32	GetAddressInfoHintFlag (EAddressInfoFlags InFlags) const override
virtual bool	GetLocalAdapterAddresses (TArray< TSharedPtr< FInternetAddr > > &OutAddresses) override
virtual FName	GetDefaultSocketProtocolFamily () const override

Static Public Member Functions
static FSocketSubsystemAndroid *	Create ()
static void	Destroy ()

Protected Member Functions
virtual class FSocketBSD *	InternalBSDSocketFactory (SOCKET Socket, ESocketType SocketType, const FString &SocketDescription, const FName &SocketProtocol) override

Protected Attributes
bool	bTriedToInit

Static Protected Attributes
static FSocketSubsystemAndroid *	SocketSingleton = NULL

Detailed Description

Android specific socket subsystem implementation

Constructor & Destructor Documentation

FSocketSubsystemAndroid()

FSocketSubsystemAndroid::FSocketSubsystemAndroid ( )

inline

~FSocketSubsystemAndroid()

virtual FSocketSubsystemAndroid::~FSocketSubsystemAndroid ( )

inlinevirtual

Member Function Documentation

Create()

FSocketSubsystemAndroid * FSocketSubsystemAndroid::Create ( )

static

Singleton interface for this subsystem

Returns

the only instance of this subsystem

Singleton interface for the Android socket subsystem

Returns

the only instance of the Android socket subsystem

Destroy()

void FSocketSubsystemAndroid::Destroy ( )

static

Performs Android specific socket clean up

Destroy the singleton Android socket subsystem

GetAddressInfoHintFlag()

int32 FSocketSubsystemAndroid::GetAddressInfoHintFlag ( EAddressInfoFlags  InFlags ) const

overridevirtual

Translates an ESocketAddressInfoFlags into a value usable by getaddrinfo

GetDefaultSocketProtocolFamily()

virtual FName FSocketSubsystemAndroid::GetDefaultSocketProtocolFamily ( ) const

inlineoverridevirtual

GetLocalAdapterAddresses()

bool FSocketSubsystemAndroid::GetLocalAdapterAddresses ( TArray< TSharedPtr< FInternetAddr > > &  OutAddresses )

overridevirtual

GetSocketAPIName()

const TCHAR * FSocketSubsystemAndroid::GetSocketAPIName ( ) const

overridevirtual

Get the name of the socket subsystem

Returns

a string naming this subsystem

Label explicitly as Android due to differences in how the kernel handles addresses

HasNetworkDevice()

bool FSocketSubsystemAndroid::HasNetworkDevice ( )

overridevirtual

Returns

Whether the device has a properly configured network device or not

Init()

bool FSocketSubsystemAndroid::Init ( FString &  Error )

overridevirtual

Does Android platform initialization of the sockets library

Parameters

Error

a string that is filled with error information

Returns

TRUE if initialized ok, FALSE otherwise

InternalBSDSocketFactory()

FSocketBSD * FSocketSubsystemAndroid::InternalBSDSocketFactory ( SOCKET  Socket, ESocketType  SocketType, const FString &  SocketDescription, const FName &  SocketProtocol  )

overrideprotectedvirtual

Create a FSocketBSD sub class capable of acquiring WifiManager.MulticastLock if needed.

Shutdown()

void FSocketSubsystemAndroid::Shutdown ( void  )

overridevirtual

Performs platform specific socket clean up

Performs Android specific socket clean up

Member Data Documentation

bTriedToInit

bool FSocketSubsystemAndroid::bTriedToInit

protected

Whether Init() has been called before or not

SocketSingleton

FSocketSubsystemAndroid * FSocketSubsystemAndroid::SocketSingleton = NULL

staticprotected

Single instantiation of this subsystem

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/Sockets/Private/Android/SocketSubsystemAndroid.h
• Engine/Source/Runtime/Sockets/Private/Android/SocketSubsystemAndroid.cpp