Code/CryPlugins/CryLobby/Module/PSNOrbis/CryPSN2Response.h

   1 // Copyright 2001-2018 Crytek GmbH / Crytek Group. All rights reserved.
   2
   3 /*
   4    Convert SCE PSN Matching2 request, signaling and room responses into an internal format that we can pass between threads.
   5    Memory is allocated in Memento, so be sure to clean it when you don't need it.
   6  */
   7
   8 #ifndef __CRYPSN2_RESPONSE_H__
   9 #define __CRYPSN2_RESPONSE_H__
  10 #pragma once
  11
  12 #if CRY_PLATFORM_ORBIS
  13         #if USE_PSN
  14
  15                 #define MAX_ROOM_EXTERNAL_BIN_ATTRIBUTES    (SCE_NP_MATCHING2_ROOM_BIN_ATTR_EXTERNAL_NUM)
  16                 #define MAX_ROOM_INTERNAL_BIN_ATTRIBUTES    (SCE_NP_MATCHING2_ROOM_BIN_ATTR_INTERNAL_NUM)
  17                 #define MAX_ROOM_SEARCHABLE_BIN_ATTRIBUTES  (SCE_NP_MATCHING2_ROOM_SEARCHABLE_BIN_ATTR_EXTERNAL_NUM)
  18                 #define MAX_ROOM_SEARCHABLE_UINT_ATTRIBUTES (SCE_NP_MATCHING2_ROOM_SEARCHABLE_INT_ATTR_EXTERNAL_NUM)
  19                 #define MAX_MEMBER_INTERNAL_BIN_ATTRIBUTES  (SCE_NP_MATCHING2_ROOMMEMBER_BIN_ATTR_INTERNAL_NUM)
  20                 #define MAX_BIN_ATTRIBUTE_SIZE              (256)             // use largest of SCE_NP_MATCHING2_ROOM_BIN_ATTR_INTERNAL_MAX_SIZE,
  21                                                                   // SCE_NP_MATCHING2_ROOM_BIN_ATTR_EXTERNAL_MAX_SIZE,
  22                                                                   // SCE_NP_MATCHING2_ROOMMEMBER_BIN_ATTR_INTERNAL_MAX_SIZE,
  23                                                                   // SCE_NP_MATCHING2_ROOM_SEARCHABLE_BIN_ATTR_EXTERNAL_MAX_SIZE
  24
  25                 #define REQUEST_EVENT_GET_WORLD_INFO_LIST            (SCE_NP_MATCHING2_REQUEST_EVENT_GET_WORLD_INFO_LIST)
  26                 #define REQUEST_EVENT_LEAVE_ROOM                     (SCE_NP_MATCHING2_REQUEST_EVENT_LEAVE_ROOM)
  27                 #define REQUEST_EVENT_SET_ROOM_MEMBER_DATA_INTERNAL  (SCE_NP_MATCHING2_REQUEST_EVENT_SET_ROOM_MEMBER_DATA_INTERNAL)
  28                 #define REQUEST_EVENT_SET_ROOM_DATA_EXTERNAL         (SCE_NP_MATCHING2_REQUEST_EVENT_SET_ROOM_DATA_EXTERNAL)
  29                 #define REQUEST_EVENT_SET_ROOM_DATA_INTERNAL         (SCE_NP_MATCHING2_REQUEST_EVENT_SET_ROOM_DATA_INTERNAL)
  30                 #define REQUEST_EVENT_GET_ROOM_DATA_EXTERNAL_LIST    (SCE_NP_MATCHING2_REQUEST_EVENT_GET_ROOM_DATA_EXTERNAL_LIST)
  31                 #define REQUEST_EVENT_SEARCH_ROOM                    (SCE_NP_MATCHING2_REQUEST_EVENT_SEARCH_ROOM)
  32                 #define REQUEST_EVENT_SIGNALING_GET_PING_INFO        (SCE_NP_MATCHING2_REQUEST_EVENT_SIGNALING_GET_PING_INFO)
  33                 #define REQUEST_EVENT_JOIN_ROOM                      (SCE_NP_MATCHING2_REQUEST_EVENT_JOIN_ROOM)
  34                 #define REQUEST_EVENT_CREATE_JOIN_ROOM               (SCE_NP_MATCHING2_REQUEST_EVENT_CREATE_JOIN_ROOM)
  35                 #define REQUEST_EVENT_GRANT_ROOM_OWNER               (SCE_NP_MATCHING2_REQUEST_EVENT_GRANT_ROOM_OWNER)
  36                 #define ROOM_EVENT_MEMBER_JOINED                     (SCE_NP_MATCHING2_ROOM_EVENT_MEMBER_JOINED)
  37                 #define ROOM_EVENT_MEMBER_LEFT                       (SCE_NP_MATCHING2_ROOM_EVENT_MEMBER_LEFT)
  38                 #define ROOM_EVENT_ROOM_OWNER_CHANGED                (SCE_NP_MATCHING2_ROOM_EVENT_ROOM_OWNER_CHANGED)
  39                 #define ROOM_EVENT_KICKED_OUT                        (SCE_NP_MATCHING2_ROOM_EVENT_KICKEDOUT)
  40                 #define ROOM_EVENT_ROOM_DESTROYED                    (SCE_NP_MATCHING2_ROOM_EVENT_ROOM_DESTROYED)
  41                 #define ROOM_EVENT_UPDATED_ROOM_DATA_INTERNAL        (SCE_NP_MATCHING2_ROOM_EVENT_UPDATED_ROOM_DATA_INTERNAL)
  42                 #define ROOM_EVENT_UPDATED_ROOM_MEMBER_DATA_INTERNAL (SCE_NP_MATCHING2_ROOM_EVENT_UPDATED_ROOM_MEMBER_DATA_INTERNAL)
  43                 #define ROOM_EVENT_UPDATED_SIGNALING_OPT_PARAM       (SCE_NP_MATCHING2_ROOM_EVENT_UPDATED_SIGNALING_OPT_PARAM)
  44                 #define SIGNALING_EVENT_DEAD                         (SCE_NP_MATCHING2_SIGNALING_EVENT_DEAD)
  45                 #define SIGNALING_EVENT_CONNECTED                    (SCE_NP_MATCHING2_SIGNALING_EVENT_ESTABLISHED)
  46                 #define SIGNALING_EVENT_NETINFO_RESULT               (SCE_NP_MATCHING2_SIGNALING_EVENT_NETINFO_RESULT)
  47
  48 struct SCryPSNServerInfoResponse
  49 {
  50         struct SServerInfo
  51         {
  52                 SceNpMatching2ServerId serverId;
  53         };
  54         SServerInfo server;
  55 };
  56
  57 struct SCryPSNBinAttribute
  58 {
  59         SceNpMatching2AttributeId m_id;
  60         uint8                     m_data[MAX_BIN_ATTRIBUTE_SIZE];
  61         uint16                    m_dataSize;
  62
  63         bool Clone(CCryLobby* pLobby, SceNpMatching2RoomMemberBinAttrInternal& memberBinAttrInternal);
  64         bool Clone(CCryLobby* pLobby, SceNpMatching2RoomBinAttrInternal& roomBinAttrInternal);
  65         bool Clone(CCryLobby* pLobby, SceNpMatching2BinAttr& binAttr);
  66         void Release(CCryLobby* pLobby) {};
  67 };
  68
  69 struct SCryPSNUIntAttribute
  70 {
  71         SceNpMatching2AttributeId m_id;
  72         uint32                    m_num;
  73
  74         bool Clone(CCryLobby* pLobby, SceNpMatching2IntAttr& intAttr);
  75         void Release(CCryLobby* pLobby) {};
  76 };
  77
  78 struct SCryPSNWorld
  79 {
  80         enum SortWorldsState
  81         {
  82                 SORT_WORLD_NONE = 0,
  83                 SORT_WORLD_NEEDS_SORTING,
  84                 SORT_WORLD_SORTED,
  85         };
  86
  87         SceNpMatching2WorldId m_worldId;
  88         uint32                m_numRooms;
  89         uint32                m_numTotalRoomMembers;
  90         uint32                m_score;
  91         uint8                 m_sortState;
  92
  93         bool Clone(CCryLobby* pLobby, SceNpMatching2World& world);
  94         void Release(CCryLobby* pLobby) {};
  95 };
  96
  97 struct SCryPSNRoomMemberDataInternal
  98 {
  99         SceNpId                    m_npId;
 100         SceNpMatching2RoomMemberId m_memberId;
 101         SceNpMatching2FlagAttr     m_flagAttr;
 102         SceNpMatching2NatType      m_natType;
 103
 104         SCryPSNBinAttribute        m_binAttributes[MAX_MEMBER_INTERNAL_BIN_ATTRIBUTES];
 105         uint16                     m_numBinAttributes;
 106
 107         bool Clone(CCryLobby* pLobby, SceNpMatching2RoomMemberDataInternalA& member);
 108         void Release(CCryLobby* pLobby);
 109 };
 110
 111 struct SCryPSNRoomDataExternal
 112 {
 113         SceNpMatching2ServerId m_serverId;
 114         SceNpMatching2WorldId  m_worldId;
 115         SceNpMatching2RoomId   m_roomId;
 116
 117         SceNpMatching2FlagAttr m_flagAttr;
 118
 119         SceNpId                m_owner;
 120
 121         SCryPSNBinAttribute    m_binAttributes[MAX_ROOM_EXTERNAL_BIN_ATTRIBUTES];
 122         SCryPSNBinAttribute    m_searchableBinAttributes[MAX_ROOM_SEARCHABLE_BIN_ATTRIBUTES];
 123         SCryPSNUIntAttribute   m_searchableUIntAttributes[MAX_ROOM_SEARCHABLE_UINT_ATTRIBUTES];
 124         uint16                 m_numBinAttributes;
 125         uint16                 m_numSearchableBinAttributes;
 126         uint16                 m_numSearchableUIntAttributes;
 127
 128         uint16                 m_maxSlots;
 129         uint16                 m_numPublicSlots;
 130         uint16                 m_numPrivateSlots;
 131         uint16                 m_numOpenPublicSlots;
 132         uint16                 m_numOpenPrivateSlots;
 133         uint16                 m_numRoomMembers;
 134
 135         bool Clone(CCryLobby* pLobby, SceNpMatching2RoomDataExternalA& roomDataExternal);
 136         void Release(CCryLobby* pLobby);
 137 };
 138
 139 struct SCryPSNRoomDataInternal
 140 {
 141         SceNpMatching2ServerId m_serverId;
 142         SceNpMatching2WorldId  m_worldId;
 143         SceNpMatching2RoomId   m_roomId;
 144
 145         SceNpMatching2FlagAttr m_flagAttr;
 146
 147         SCryPSNBinAttribute    m_binAttributes[MAX_ROOM_INTERNAL_BIN_ATTRIBUTES];
 148         uint16                 m_numBinAttributes;
 149
 150         uint16                 m_maxSlots;
 151         uint16                 m_numPublicSlots;
 152         uint16                 m_numPrivateSlots;
 153         uint16                 m_numOpenPublicSlots;
 154         uint16                 m_numOpenPrivateSlots;
 155
 156         bool Clone(CCryLobby* pLobby, SceNpMatching2RoomDataInternal& roomDataInternal);
 157         void Release(CCryLobby* pLobby);
 158 };
 159
 160 struct SCryPSNRoomMemberDataInternalList
 161 {
 162         TMemHdl                        m_memHdl;
 163         SCryPSNRoomMemberDataInternal* m_pRoomMembers;
 164         uint16                         m_numRoomMembers;
 165         uint16                         m_me;
 166         uint16                         m_owner;
 167
 168         bool Clone(CCryLobby* pLobby, SceNpMatching2RoomMemberDataInternalListA& memberList);
 169         void Release(CCryLobby* pLobby);
 170 };
 171
 172 struct SCryPSNGetWorldInfoListResponse
 173 {
 174         TMemHdl       m_memHdl;
 175         SCryPSNWorld* m_pWorlds;
 176         uint16        m_numWorlds;
 177
 178         bool Clone(CCryLobby* pLobby, SceNpMatching2GetWorldInfoListResponse* pResponse);
 179         void Release(CCryLobby* pLobby);
 180 };
 181
 182 struct SCryPSNCreateJoinRoomResponse
 183 {
 184         SCryPSNRoomDataInternal           m_roomInfo;
 185         SCryPSNRoomMemberDataInternalList m_roomMembers;
 186
 187         bool Clone(CCryLobby* pLobby, SceNpMatching2CreateJoinRoomResponseA* pResponse);
 188         void Release(CCryLobby* pLobby);
 189 };
 190
 191 struct SCryPSNJoinRoomResponse
 192 {
 193         SCryPSNRoomDataInternal           m_roomInfo;
 194         SCryPSNRoomMemberDataInternalList m_roomMembers;
 195
 196         bool Clone(CCryLobby* pLobby, SceNpMatching2JoinRoomResponseA* pResponse);
 197         void Release(CCryLobby* pLobby);
 198 };
 199
 200 struct SCryPSNSearchRoomResponse
 201 {
 202         TMemHdl                  m_memHdl;
 203         SCryPSNRoomDataExternal* m_pRooms;
 204         uint16                   m_numRooms;
 205
 206         bool Clone(CCryLobby* pLobby, SceNpMatching2SearchRoomResponseA* pResponse);
 207         bool Clone(CCryLobby* pLobby, SceNpMatching2GetRoomDataExternalListResponseA* pResponse);
 208         void Release(CCryLobby* pLobby);
 209 };
 210
 211 struct SCryPSNLeaveRoomResponse
 212 {
 213         SceNpMatching2RoomId m_roomId;
 214
 215         bool Clone(CCryLobby* pLobby, SceNpMatching2LeaveRoomResponse* pResponse);
 216         void Release(CCryLobby* pLobby);
 217 };
 218
 219 struct SCryPSNSignalingGetPingInfoResponse
 220 {
 221         SceNpMatching2ServerId m_serverId;
 222         SceNpMatching2WorldId  m_worldId;
 223         SceNpMatching2RoomId   m_roomId;
 224         uint32                 m_rtt;
 225
 226         bool Clone(CCryLobby* pLobby, SceNpMatching2SignalingGetPingInfoResponse* pResponse);
 227         void Release(CCryLobby* pLobby) {};
 228 };
 229
 230 struct SCryPSNRoomMemberUpdateInfoResponse
 231 {
 232         SCryPSNRoomMemberDataInternal m_member;
 233         SceNpMatching2EventCause      m_eventCause;
 234
 235         bool Clone(CCryLobby* pLobby, SceNpMatching2RoomMemberUpdateInfoA* pResponse);
 236         bool Clone(CCryLobby* pLobby, SceNpMatching2RoomMemberDataInternalUpdateInfoA* pResponse);
 237         void Release(CCryLobby* pLobby);
 238 };
 239
 240 struct SCryPSNRoomOwnerUpdateInfoResponse
 241 {
 242         SceNpMatching2RoomMemberId m_prevOwner;
 243         SceNpMatching2RoomMemberId m_newOwner;
 244         SceNpMatching2EventCause   m_eventCause;
 245
 246         bool Clone(CCryLobby* pLobby, SceNpMatching2RoomOwnerUpdateInfo* pResponse);
 247         void Release(CCryLobby* pLobby) {};
 248 };
 249
 250 struct SCryPSNRoomUpdateInfoResponse
 251 {
 252         SceNpMatching2EventCause m_eventCause;
 253         int                      m_errorCode;
 254
 255         bool Clone(CCryLobby* pLobby, SceNpMatching2RoomUpdateInfo* pResponse);
 256         void Release(CCryLobby* pLobby) {};
 257 };
 258
 259         #endif // USE_PSN
 260 #endif   // CRY_PLATFORM_ORBIS
 261
 262 #endif // __CRYPSN2_RESPONSE_H__