Documentation for the Unreal C++ Library
|
#include <PVROnlineSession.h>
Public Member Functions | |
virtual | ~FPVROnlineSession () |
virtual bool | CancelFindSessions () override |
virtual bool | CancelMatchmaking (const FUniqueNetId &SearchingPlayerId, FName SessionName) override |
virtual bool | CancelMatchmaking (int32 SearchingPlayerNum, FName SessionName) override |
uint32 | CreateInternetSession (int32 HostingPlayerNum, FNamedOnlineSession *Session) |
uint32 | CreateLANSession (int32 HostingPlayerNum, FNamedOnlineSession *Session) |
virtual bool | CreateSession (const FUniqueNetId &HostingPlayerId, FName SessionName, const FOnlineSessionSettings &NewSessionSettings) override |
virtual bool | CreateSession (int32 HostingPlayerNum, FName SessionName, const FOnlineSessionSettings &NewSessionSettings) override |
virtual TSharedPtr< const FUniqueNetId > | CreateSessionIdFromString (const FString &SessionIdStr) override |
DEFINE_ONLINE_DELEGATE (OnFindSessionsStart) | |
DEFINE_ONLINE_DELEGATE (OnJoinSessionStart) | |
uint32 | DestroyInternetSession (FNamedOnlineSession *Session, const FOnDestroySessionCompleteDelegate &CompletionDelegate=FOnDestroySessionCompleteDelegate()) |
uint32 | DestroyLANSession (FName SessionName, const FOnDestroySessionCompleteDelegate &CompletionDelegate=FOnDestroySessionCompleteDelegate()) |
virtual bool | DestroySession (FName SessionName, const FOnDestroySessionCompleteDelegate &CompletionDelegate=FOnDestroySessionCompleteDelegate()) override |
virtual void | DumpSessionState () override |
uint32 | EndInternetSession (FNamedOnlineSession *Session) |
virtual bool | EndSession (FName SessionName) override |
virtual bool | FindFriendSession (const FUniqueNetId &LocalUserId, const FUniqueNetId &Friend) override |
virtual bool | FindFriendSession (const FUniqueNetId &LocalUserId, const TArray< TSharedRef< const FUniqueNetId > > &FriendList) override |
virtual bool | FindFriendSession (int32 LocalUserNum, const FUniqueNetId &Friend) override |
virtual bool | FindSessionById (const FUniqueNetId &SearchingUserId, const FUniqueNetId &SessionId, const FUniqueNetId &FriendId, const FOnSingleSessionResultCompleteDelegate &CompletionDelegate) override |
virtual bool | FindSessions (const FUniqueNetId &SearchingPlayerId, const TSharedRef< FOnlineSessionSearch > &SearchSettings) override |
virtual bool | FindSessions (int32 SearchingPlayerNum, const TSharedRef< FOnlineSessionSearch > &SearchSettings) override |
FNamedOnlineSession * | GetFirstNamedSession () |
FNamedOnlineSession * | GetNamedSession (FName SessionName) override |
virtual int32 | GetNumSessions () override |
virtual bool | GetResolvedConnectString (const FOnlineSessionSearchResult &SearchResult, FName PortType, FString &ConnectInfo) override |
virtual bool | GetResolvedConnectString (FName SessionName, FString &ConnectInfo, FName PortType) override |
virtual FOnlineSessionSettings * | GetSessionSettings (FName SessionName) override |
virtual EOnlineSessionState::Type | GetSessionState (FName SessionName) const override |
virtual bool | HasPresenceSession () override |
virtual bool | IsPlayerInSession (FName SessionName, const FUniqueNetId &UniqueId) override |
virtual bool | JoinSession (const FUniqueNetId &PlayerId, FName SessionName, const FOnlineSessionSearchResult &DesiredSession) override |
virtual bool | JoinSession (int32 PlayerNum, FName SessionName, const FOnlineSessionSearchResult &DesiredSession) override |
void | OnSessionListenPortChanged (int32 Port) |
virtual bool | PingSearchResults (const FOnlineSessionSearchResult &SearchResult) override |
virtual void | RegisterLocalPlayer (const FUniqueNetId &PlayerId, FName SessionName, const FOnRegisterLocalPlayerCompleteDelegate &Delegate) override |
virtual bool | RegisterPlayer (FName SessionName, const FUniqueNetId &PlayerId, bool bWasInvited) override |
virtual bool | RegisterPlayers (FName SessionName, const TArray< TSharedRef< const FUniqueNetId > > &Players, bool bWasInvited=false) override |
virtual void | RemoveNamedSession (FName SessionName) override |
virtual bool | SendSessionInviteToFriend (const FUniqueNetId &LocalUserId, FName SessionName, const FUniqueNetId &Friend) override |
virtual bool | SendSessionInviteToFriend (int32 LocalUserNum, FName SessionName, const FUniqueNetId &Friend) override |
virtual bool | SendSessionInviteToFriends (const FUniqueNetId &LocalUserId, FName SessionName, const TArray< TSharedRef< const FUniqueNetId > > &Friends) override |
virtual bool | SendSessionInviteToFriends (int32 LocalUserNum, FName SessionName, const TArray< TSharedRef< const FUniqueNetId > > &Friends) override |
virtual bool | StartMatchmaking (const TArray< TSharedRef< const FUniqueNetId > > &LocalPlayers, FName SessionName, const FOnlineSessionSettings &NewSessionSettings, TSharedRef< FOnlineSessionSearch > &SearchSettings) override |
virtual bool | StartSession (FName SessionName) override |
virtual void | UnregisterLocalPlayer (const FUniqueNetId &PlayerId, FName SessionName, const FOnUnregisterLocalPlayerCompleteDelegate &Delegate) override |
virtual bool | UnregisterPlayer (FName SessionName, const FUniqueNetId &PlayerId) override |
virtual bool | UnregisterPlayers (FName SessionName, const TArray< TSharedRef< const FUniqueNetId > > &Players) override |
virtual bool | UpdateSession (FName SessionName, FOnlineSessionSettings &UpdatedSessionSettings, bool bShouldRefreshOnlineData=true) override |
Public Attributes | |
int32 | HostSessionPort |
Protected Member Functions | |
FPVROnlineSession (class FPVROSubsystem *InSubsystem) | |
class FNamedOnlineSession * | AddNamedSession (FName SessionName, const FOnlineSession &Session) override |
class FNamedOnlineSession * | AddNamedSession (FName SessionName, const FOnlineSessionSettings &SessionSettings) override |
void | CheckMatchesFound (TSharedPtr< FJsonObject > &JsonMessageObject) |
void | CheckPendingSessionInvite () |
bool | ClearSessionSearch (EOnlineAsyncTaskState::Type TaskState=EOnlineAsyncTaskState::Done) |
FString | GetCustomDedicatedServerName () const |
Returns the custom server name if specified as argument. | |
void | GetHostAndPort (int32 &Host, int32 &Port, const FString &HostIP, const FString &HostPort) |
void | HandleMessageReceived (const FString &InJsonMessage) |
void | RegisterLocalPlayers (class FNamedOnlineSession *Session) |
void | RegisterVoice (const FUniqueNetId &PlayerId) |
void | Tick (float DeltaTime) |
void | UnregisterLocalPlayers (class FNamedOnlineSession *Session) |
void | UnregisterVoice (const FUniqueNetId &PlayerId) |
Protected Attributes | |
TSharedPtr< FOnlineSessionSearch > | CurrentSessionSearch |
TSharedPtr< FUniqueNetIdPixoVR > | GameServerPixoVRId |
FCriticalSection | SessionLock |
TArray< FNamedOnlineSession > | Sessions |
double | SessionSearchEndTime |
double | SessionSearchStartTime |
Private Member Functions | |
FPVROnlineSession () | |
uint32 | FinalizeLANSearch () |
uint32 | FindInternetSession (const TSharedRef< FOnlineSessionSearch > &SearchSettings) |
uint32 | FindLANSession (const TSharedRef< FOnlineSessionSearch > &SearchSettings) |
bool | IsHost (const FNamedOnlineSession &Session) const |
bool | IsSessionJoinable (const FNamedOnlineSession &Session) const |
uint32 | JoinInternetSession (int32 PlayerNum, class FNamedOnlineSession *Session, const class FOnlineSession *SearchSession) |
bool | NeedsToAdvertise () |
bool | NeedsToAdvertise (FNamedOnlineSession &Session) |
void | OnLANSearchTimeout () |
void | OnValidQueryPacketReceived (uint8 *PacketData, int32 PacketLength, uint64 ClientNonce) |
void | OnValidResponsePacketReceived (uint8 *PacketData, int32 PacketLength) |
void | TickLanTasks (float DeltaTime) |
uint32 | UpdateLANStatus () |
Static Private Member Functions | |
static void | SetPortFromNetDriver (const FPVROSubsystem &Subsystem, const TSharedPtr< FOnlineSessionInfo > &SessionInfo) |
Private Attributes | |
FPVROSession | LANSessionManager |
class FPVROSubsystem * | Subsystem |
Interface definition for the online services session services Session services are defined as anything related managing a session and its state within a platform service
Definition at line 33 of file PVROnlineSession.h.
|
inlineprivate |
Hidden on purpose
Definition at line 44 of file PVROnlineSession.h.
|
protected |
|
inlinevirtual |
Definition at line 232 of file PVROnlineSession.h.
|
inlineoverrideprotected |
Definition at line 182 of file PVROnlineSession.h.
|
inlineoverrideprotected |
|
overridevirtual |
Definition at line 717 of file PVROnlineSession.cpp.
|
overridevirtual |
Definition at line 605 of file PVROnlineSession.cpp.
|
overridevirtual |
Definition at line 598 of file PVROnlineSession.cpp.
|
protected |
Definition at line 127 of file PVROnlineSession.cpp.
|
protected |
Parse the command line for invite/join information at launch
|
protected |
uint32 FPVROnlineSession::CreateInternetSession | ( | int32 | HostingPlayerNum, |
FNamedOnlineSession * | Session ) |
uint32 FPVROnlineSession::CreateLANSession | ( | int32 | HostingPlayerNum, |
FNamedOnlineSession * | Session ) |
Definition at line 186 of file PVROnlineSession.cpp.
|
overridevirtual |
|
overridevirtual |
Definition at line 214 of file PVROnlineSession.cpp.
|
overridevirtual |
Definition at line 1314 of file PVROnlineSession.cpp.
FPVROnlineSession::DEFINE_ONLINE_DELEGATE | ( | OnFindSessionsStart | ) |
FPVROnlineSession::DEFINE_ONLINE_DELEGATE | ( | OnJoinSessionStart | ) |
uint32 FPVROnlineSession::DestroyInternetSession | ( | FNamedOnlineSession * | Session, |
const FOnDestroySessionCompleteDelegate & | CompletionDelegate = FOnDestroySessionCompleteDelegate() ) |
Definition at line 556 of file PVROnlineSession.cpp.
uint32 FPVROnlineSession::DestroyLANSession | ( | FName | SessionName, |
const FOnDestroySessionCompleteDelegate & | CompletionDelegate = FOnDestroySessionCompleteDelegate() ) |
|
overridevirtual |
|
overridevirtual |
Definition at line 1268 of file PVROnlineSession.cpp.
uint32 FPVROnlineSession::EndInternetSession | ( | FNamedOnlineSession * | Session | ) |
|
overridevirtual |
|
private |
Finishes searching over LAN and returns to hosting (if needed)
Definition at line 1232 of file PVROnlineSession.cpp.
|
overridevirtual |
Definition at line 854 of file PVROnlineSession.cpp.
|
overridevirtual |
Definition at line 862 of file PVROnlineSession.cpp.
|
overridevirtual |
Definition at line 846 of file PVROnlineSession.cpp.
|
private |
Will use the Agones to find sessions.
Definition at line 669 of file PVROnlineSession.cpp.
|
private |
Will use the Agones to find sessions.
Definition at line 688 of file PVROnlineSession.cpp.
|
overridevirtual |
Definition at line 662 of file PVROnlineSession.cpp.
|
overridevirtual |
|
overridevirtual |
Definition at line 612 of file PVROnlineSession.cpp.
|
protected |
Returns the custom server name if specified as argument.
Definition at line 1333 of file PVROnlineSession.cpp.
|
inline |
Definition at line 239 of file PVROnlineSession.h.
|
protected |
|
inlineoverride |
|
overridevirtual |
|
overridevirtual |
|
overridevirtual |
|
overridevirtual |
|
inlineoverridevirtual |
Definition at line 275 of file PVROnlineSession.h.
|
protected |
Definition at line 90 of file PVROnlineSession.cpp.
|
inlineoverridevirtual |
Definition at line 289 of file PVROnlineSession.h.
|
private |
Returns true if the session owner is also the host.
Definition at line 1298 of file PVROnlineSession.cpp.
|
overridevirtual |
Definition at line 586 of file PVROnlineSession.cpp.
|
private |
Determines whether this particular session is joinable.
Definition at line 335 of file PVROnlineSession.cpp.
|
private |
Join a multiplayer session
PlayerNum | local index of the user initiating the request |
Session | newly allocated session with join information |
SearchSession | the desired session to join |
Definition at line 894 of file PVROnlineSession.cpp.
|
overridevirtual |
|
overridevirtual |
Definition at line 776 of file PVROnlineSession.cpp.
|
private |
Checks whether there are any sessions that need to be advertised (over LAN)
Definition at line 302 of file PVROnlineSession.cpp.
|
private |
Determines whether this particular session should be advertised (over LAN)
Definition at line 320 of file PVROnlineSession.cpp.
|
private |
Delegate triggered when the LAN beacon has finished searching (some time after last received host packet)
Definition at line 1242 of file PVROnlineSession.cpp.
void FPVROnlineSession::OnSessionListenPortChanged | ( | int32 | Port | ) |
|
private |
Delegate triggered when the LAN beacon has detected a valid client request has been received
PacketData | packet data sent by the requesting client with header information removed |
PacketLength | length of the packet not including header size |
ClientNonce | the nonce returned by the client to return with the server packet |
Definition at line 1182 of file PVROnlineSession.cpp.
|
private |
Delegate triggered when the LAN beacon has detected a valid host response to a client request has been received
PacketData | packet data sent by the requesting client with header information removed |
PacketLength | length of the packet not including header size |
Definition at line 1213 of file PVROnlineSession.cpp.
|
overridevirtual |
Definition at line 918 of file PVROnlineSession.cpp.
|
overridevirtual |
Definition at line 1278 of file PVROnlineSession.cpp.
|
protected |
Registers all local players with the current session
Session | the session that they are registering in |
Definition at line 1015 of file PVROnlineSession.cpp.
|
overridevirtual |
|
overridevirtual |
Definition at line 1081 of file PVROnlineSession.cpp.
|
protected |
Registers and updates voice data for the given player id
PlayerId | player to register with the voice subsystem |
Definition at line 1031 of file PVROnlineSession.cpp.
|
inlineoverridevirtual |
|
overridevirtual |
Definition at line 876 of file PVROnlineSession.cpp.
|
overridevirtual |
Definition at line 870 of file PVROnlineSession.cpp.
|
overridevirtual |
Definition at line 888 of file PVROnlineSession.cpp.
|
overridevirtual |
Definition at line 882 of file PVROnlineSession.cpp.
|
staticprivate |
Attempt to set the host port in the session info based on the actual port the netdriver is using.
Definition at line 1288 of file PVROnlineSession.cpp.
|
overridevirtual |
Definition at line 591 of file PVROnlineSession.cpp.
|
overridevirtual |
|
protected |
Session tick for various background tasks
Definition at line 1161 of file PVROnlineSession.cpp.
|
private |
Ticks any lan beacon background tasks
DeltaTime | the time since the last tick |
Definition at line 1176 of file PVROnlineSession.cpp.
|
overridevirtual |
Definition at line 1283 of file PVROnlineSession.cpp.
|
protected |
Unregisters all local players with the current session
Session | the session that they are registering in |
|
overridevirtual |
|
overridevirtual |
Definition at line 1127 of file PVROnlineSession.cpp.
|
protected |
Unregisters a given player id from the voice subsystem
PlayerId | player to unregister with the voice subsystem |
Definition at line 1051 of file PVROnlineSession.cpp.
|
private |
Updates the status of LAN session (creates it if needed, shuts down if not)
Definition at line 352 of file PVROnlineSession.cpp.
|
overridevirtual |
|
protected |
Definition at line 156 of file PVROnlineSession.h.
|
protected |
Definition at line 150 of file PVROnlineSession.h.
int32 FPVROnlineSession::HostSessionPort |
Definition at line 236 of file PVROnlineSession.h.
|
private |
Handles advertising sessions over LAN and client searches
Definition at line 41 of file PVROnlineSession.h.
|
mutableprotected |
Definition at line 152 of file PVROnlineSession.h.
|
protected |
Definition at line 154 of file PVROnlineSession.h.
|
protected |
Definition at line 160 of file PVROnlineSession.h.
|
protected |
Current search start time.
Definition at line 159 of file PVROnlineSession.h.
|
private |
Reference to the main PixoVR subsystem
Definition at line 38 of file PVROnlineSession.h.