1 /*---------------------------------------------------------------------------* 2 Project: Horizon 3 File: friends_Api.h 4 5 Copyright 2009 Nintendo. All rights reserved. 6 7 These coded instructions, statements, and computer programs contain 8 proprietary information of Nintendo of America Inc. and/or Nintendo 9 Company Ltd., and are protected by Federal copyright law. They may 10 not be disclosed to third parties or copied or duplicated in any form, 11 in whole or in part, without the prior written consent of Nintendo. 12 13 $Rev: 38552 $ 14 *---------------------------------------------------------------------------*/ 15 16 #ifndef NN_FRIENDS_CTR_FRIENDS_API_H_ 17 #define NN_FRIENDS_CTR_FRIENDS_API_H_ 18 19 /* Please see man pages for details 20 21 */ 22 23 #include <nn/types.h> 24 25 #include <nn/friends/friends_Result.h> 26 #include <nn/friends/CTR/friends_Types.h> 27 28 #include <nn/uds/CTR/uds_Type.h> 29 30 #ifdef __cplusplus 31 32 namespace nn { 33 namespace friends { 34 namespace CTR { 35 36 namespace detail 37 { 38 // Library initialization and termination 39 Result Initialize(); 40 Result Finalize(); 41 42 // Library state confirmation 43 bool IsInitialized(); 44 bool HasLoggedIn(); 45 46 // Connection management 47 Result Login( os::Event* pEvent ); 48 Result Logout(); 49 50 // Get local information (local) 51 PrincipalId GetMyPrincipalId(); 52 Result GetMyPreference( bool* pIsPublicMode, bool* pIsShowGameName, bool* pIsShowPlayedGame ); 53 Result GetMyProfile( Profile* pProfile ); 54 Result GetMyPresence( MyPresence* pMyPresence ); 55 Result GetMyScreenName( char16 screenName[SCREEN_NAME_SIZE] ); 56 Result GetMyMii( MiiData* pMiiData ); 57 58 // Get friend information 59 Result GetFriendKeyList( FriendKey* pFriendKeyList, size_t* pNum, size_t offset, size_t size ); 60 Result GetFriendPresence( FriendPresence* pFriendPresenceList, const FriendKey* pFriendKeyList, size_t size ); 61 Result GetFriendPresence( FriendPresence* pFriendPresenceList, const PrincipalId* pPrincipalIdList, size_t size ); 62 Result GetFriendScreenName( char16 (*pScreenNameList)[SCREEN_NAME_SIZE], const FriendKey* pFriendKeyList, size_t size, bool replaceForeignCharacters, u8* pFontRegionList ); 63 Result GetFriendScreenName( char16 (*pScreenNameList)[SCREEN_NAME_SIZE], const PrincipalId* pPrincipalIdList, size_t size, bool replaceForeignCharacters, u8* pFontRegionList ); 64 Result GetFriendMii( MiiData* pMiiDataList, const FriendKey* pFriendKeyList, size_t size ); 65 Result GetFriendMii( MiiData* pMiiDataList, const PrincipalId* pPrincipalIdList, size_t size ); 66 Result GetFriendProfile( Profile* pProfileList, const FriendKey* pFriendKeyList, size_t size ); 67 Result GetFriendProfile( Profile* pProfileList, const PrincipalId* pPrincipalIdList, size_t size ); 68 Result GetFriendAttributeFlags( bit32* pAttributeFlagsList, const FriendKey* pFriendKeyList, size_t size ); 69 Result GetFriendAttributeFlags( bit32* pAttributeFlagsList, const PrincipalId* pPrincipalIdList, size_t size ); 70 Result UnscrambleLocalFriendCode( LocalFriendCode* pLocalFriendCodeList, const uds::CTR::ScrambledLocalFriendCode* pScrambledLocalFriendCodeList, size_t size ); 71 72 // Update local information 73 Result UpdateGameModeDescription( const char16 description[MODE_DESCRIPTION_SIZE] ); 74 75 // Get notification content 76 Result AttachToEventNotification( nn::os::Event* pEvent ); 77 Result SetNotificationMask( bit32 mask ); 78 u32 GetEventNotification( EventNotification* pEventNotificationList, size_t size, bool* pHasOverflowed ); 79 Result GetLastResponseResult(); 80 81 // Get error code 82 u32 ResultToErrorCode( const Result& result ); 83 } 84 85 namespace 86 { 87 static const char PORT_NAME_USER[] = "frd:u"; 88 } 89 90 /*------------------------------------------------------------------- 91 Library initialization and termination 92 -------------------------------------------------------------------*/ 93 94 /* Please see man pages for details 95 96 97 98 99 100 101 */ 102 Result Initialize(); Initialize()103 inline Result Initialize() 104 { 105 return detail::Initialize(); 106 } 107 108 /* Please see man pages for details 109 110 111 112 113 114 115 116 117 118 119 */ 120 Result Finalize(); Finalize()121 inline Result Finalize() 122 { 123 return detail::Finalize(); 124 } 125 126 /* Please see man pages for details 127 128 129 130 131 132 133 */ 134 bool IsInitialized(); IsInitialized()135 inline bool IsInitialized() 136 { 137 return detail::IsInitialized(); 138 } 139 140 /* Please see man pages for details 141 142 143 144 145 146 147 148 149 150 */ 151 bool HasLoggedIn(); HasLoggedIn()152 inline bool HasLoggedIn() 153 { 154 return detail::HasLoggedIn(); 155 } 156 157 /* Please see man pages for details 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 */ 182 Result Login( os::Event* pEvent ); Login(os::Event * pEvent)183 inline Result Login( os::Event* pEvent ) 184 { 185 return detail::Login( pEvent ); 186 } 187 188 /* Please see man pages for details 189 190 191 192 193 194 195 196 197 198 199 200 201 202 */ 203 Result Logout(); Logout()204 inline Result Logout() 205 { 206 return detail::Logout(); 207 } 208 209 /* Please see man pages for details 210 211 212 213 214 215 216 217 218 */ 219 PrincipalId GetMyPrincipalId(); GetMyPrincipalId()220 inline PrincipalId GetMyPrincipalId() 221 { 222 return detail::GetMyPrincipalId(); 223 } 224 225 /* Please see man pages for details 226 227 228 229 230 231 232 233 234 235 236 237 238 */ 239 Result GetMyPreference( bool* pIsPublicMode, bool* pIsShowGameName, bool* pIsShowPlayedGame ); GetMyPreference(bool * pIsPublicMode,bool * pIsShowGameName,bool * pIsShowPlayedGame)240 inline Result GetMyPreference( bool* pIsPublicMode, bool* pIsShowGameName, bool* pIsShowPlayedGame ) 241 { 242 return detail::GetMyPreference( pIsPublicMode, pIsShowGameName, pIsShowPlayedGame ); 243 } 244 245 /* Please see man pages for details 246 247 248 249 250 251 252 253 254 255 256 */ 257 Result GetMyProfile( Profile* pProfile ); GetMyProfile(Profile * pProfile)258 inline Result GetMyProfile( Profile* pProfile ) 259 { 260 return detail::GetMyProfile( pProfile ); 261 } 262 263 /* Please see man pages for details 264 265 266 267 268 269 270 271 272 273 274 */ 275 Result GetMyPresence( MyPresence* pMyPresence ); GetMyPresence(MyPresence * pMyPresence)276 inline Result GetMyPresence( MyPresence* pMyPresence ) 277 { 278 return detail::GetMyPresence( pMyPresence ); 279 } 280 281 /* Please see man pages for details 282 283 284 285 286 287 288 289 290 291 292 293 294 295 */ 296 Result GetMyScreenName( char16 screenName[SCREEN_NAME_SIZE] ); GetMyScreenName(char16 screenName[SCREEN_NAME_SIZE])297 inline Result GetMyScreenName( char16 screenName[SCREEN_NAME_SIZE] ) 298 { 299 return detail::GetMyScreenName( screenName ); 300 } 301 302 /* Please see man pages for details 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 */ 319 Result GetMyMii( MiiData* pMiiData ); GetMyMii(MiiData * pMiiData)320 inline Result GetMyMii( MiiData* pMiiData ) 321 { 322 return detail::GetMyMii( pMiiData ); 323 } 324 325 /* Please see man pages for details 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 */ 343 Result GetFriendKeyList( FriendKey* pFriendKeyList, size_t* pNum, size_t offset = 0, size_t size = FRIEND_LIST_SIZE ); GetFriendKeyList(FriendKey * pFriendKeyList,size_t * pNum,size_t offset,size_t size)344 inline Result GetFriendKeyList( FriendKey* pFriendKeyList, size_t* pNum, size_t offset, size_t size) 345 { 346 return detail::GetFriendKeyList( pFriendKeyList, pNum, offset, size ); 347 } 348 349 /* Please see man pages for details 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 */ 369 Result GetFriendPresence( FriendPresence* pFriendPresenceList, const FriendKey* pFriendKeyList, size_t size = 1 ); GetFriendPresence(FriendPresence * pFriendPresenceList,const FriendKey * pFriendKeyList,size_t size)370 inline Result GetFriendPresence( FriendPresence* pFriendPresenceList, const FriendKey* pFriendKeyList, size_t size) 371 { 372 return detail::GetFriendPresence( pFriendPresenceList, pFriendKeyList, size ); 373 } 374 375 /* Please see man pages for details 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 */ 395 Result GetFriendPresence( FriendPresence* pFriendPresenceList, const PrincipalId* pPrincipalIdList, size_t size = 1 ); GetFriendPresence(FriendPresence * pFriendPresenceList,const PrincipalId * pPrincipalIdList,size_t size)396 inline Result GetFriendPresence( FriendPresence* pFriendPresenceList, const PrincipalId* pPrincipalIdList, size_t size) 397 { 398 return detail::GetFriendPresence( pFriendPresenceList, pPrincipalIdList, size ); 399 } 400 401 /* Please see man pages for details 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 */ 427 Result GetFriendScreenName( 428 char16 (*pScreenNameList)[SCREEN_NAME_SIZE], 429 const FriendKey* pFriendKeyList, 430 size_t size = 1, 431 bool replaceForeignCharacters = true, 432 u8* pFontRegionList = NULL 433 ); GetFriendScreenName(char16 (* pScreenNameList)[SCREEN_NAME_SIZE],const FriendKey * pFriendKeyList,size_t size,bool replaceForeignCharacters,u8 * pFontRegionList)434 inline Result GetFriendScreenName( 435 char16 (*pScreenNameList)[SCREEN_NAME_SIZE], 436 const FriendKey* pFriendKeyList, 437 size_t size, 438 bool replaceForeignCharacters, 439 u8* pFontRegionList 440 ) 441 { 442 return detail::GetFriendScreenName( pScreenNameList, pFriendKeyList, size, replaceForeignCharacters, pFontRegionList ); 443 } 444 445 /* Please see man pages for details 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 */ 471 Result GetFriendScreenName( 472 char16 (*pScreenNameList)[SCREEN_NAME_SIZE], 473 const PrincipalId* pPrincipalIdList, 474 size_t size = 1, 475 bool replaceForeignCharacters = true, 476 u8* pFontRegionList = NULL 477 ); GetFriendScreenName(char16 (* pScreenNameList)[SCREEN_NAME_SIZE],const PrincipalId * pPrincipalIdList,size_t size,bool replaceForeignCharacters,u8 * pFontRegionList)478 inline Result GetFriendScreenName( 479 char16 (*pScreenNameList)[SCREEN_NAME_SIZE], 480 const PrincipalId* pPrincipalIdList, 481 size_t size, 482 bool replaceForeignCharacters, 483 u8* pFontRegionList 484 ) 485 { 486 return detail::GetFriendScreenName( pScreenNameList, pPrincipalIdList, size, replaceForeignCharacters, pFontRegionList ); 487 } 488 489 /* Please see man pages for details 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 */ 509 Result GetFriendMii( MiiData* pMiiDataList, const FriendKey* pFriendKeyList, size_t size = 1 ); GetFriendMii(MiiData * pMiiDataList,const FriendKey * pFriendKeyList,size_t size)510 inline Result GetFriendMii( MiiData* pMiiDataList, const FriendKey* pFriendKeyList, size_t size) 511 { 512 return detail::GetFriendMii( pMiiDataList, pFriendKeyList, size ); 513 } 514 515 /* Please see man pages for details 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 */ 535 Result GetFriendMii( MiiData* pMiiDataList, const PrincipalId* pPrincipalIdList, size_t size = 1); GetFriendMii(MiiData * pMiiDataList,const PrincipalId * pPrincipalIdList,size_t size)536 inline Result GetFriendMii( MiiData* pMiiDataList, const PrincipalId* pPrincipalIdList, size_t size) 537 { 538 return detail::GetFriendMii( pMiiDataList, pPrincipalIdList, size ); 539 } 540 541 /* Please see man pages for details 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 */ 563 Result GetFriendProfile( Profile* pProfileList, const FriendKey* pFriendKeyList, size_t size = 1 ); GetFriendProfile(Profile * pProfileList,const FriendKey * pFriendKeyList,size_t size)564 inline Result GetFriendProfile( Profile* pProfileList, const FriendKey* pFriendKeyList, size_t size) 565 { 566 return detail::GetFriendProfile( pProfileList, pFriendKeyList, size ); 567 } 568 569 /* Please see man pages for details 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 */ 591 Result GetFriendProfile( Profile* pProfileList, const PrincipalId* pPrincipalIdList, size_t size = 1 ); GetFriendProfile(Profile * pProfileList,const PrincipalId * pPrincipalIdList,size_t size)592 inline Result GetFriendProfile( Profile* pProfileList, const PrincipalId* pPrincipalIdList, size_t size) 593 { 594 return detail::GetFriendProfile( pProfileList, pPrincipalIdList, size ); 595 } 596 597 /* Please see man pages for details 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 */ 615 Result GetFriendAttributeFlags( bit32* pAttributeFlagsList, const FriendKey* pFriendKeyList, size_t size = 1 ); GetFriendAttributeFlags(bit32 * pAttributeFlagsList,const FriendKey * pFriendKeyList,size_t size)616 inline Result GetFriendAttributeFlags( bit32* pAttributeFlagsList, const FriendKey* pFriendKeyList, size_t size) 617 { 618 return detail::GetFriendAttributeFlags( pAttributeFlagsList, pFriendKeyList, size ); 619 } 620 621 /* Please see man pages for details 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 */ 639 Result GetFriendAttributeFlags( bit32* pAttributeFlagsList, const PrincipalId* pPrincipalIdList, size_t size = 1 ); GetFriendAttributeFlags(bit32 * pAttributeFlagsList,const PrincipalId * pPrincipalIdList,size_t size)640 inline Result GetFriendAttributeFlags( bit32* pAttributeFlagsList, const PrincipalId* pPrincipalIdList, size_t size) 641 { 642 return detail::GetFriendAttributeFlags( pAttributeFlagsList, pPrincipalIdList, size ); 643 } 644 645 /* Please see man pages for details 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 */ 663 Result UnscrambleLocalFriendCode( LocalFriendCode* pLocalFriendCodeList, const uds::CTR::ScrambledLocalFriendCode* pScrambledLocalFriendCodeList, size_t size = 1); UnscrambleLocalFriendCode(LocalFriendCode * pLocalFriendCodeList,const uds::CTR::ScrambledLocalFriendCode * pScrambledLocalFriendCodeList,size_t size)664 inline Result UnscrambleLocalFriendCode( LocalFriendCode* pLocalFriendCodeList, const uds::CTR::ScrambledLocalFriendCode* pScrambledLocalFriendCodeList, size_t size ) 665 { 666 return detail::UnscrambleLocalFriendCode( pLocalFriendCodeList, pScrambledLocalFriendCodeList, size ); 667 } 668 669 /* Please see man pages for details 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 */ 697 Result UpdateGameModeDescription( const char16 description[MODE_DESCRIPTION_SIZE] ); UpdateGameModeDescription(const char16 description[MODE_DESCRIPTION_SIZE])698 inline Result UpdateGameModeDescription( const char16 description[MODE_DESCRIPTION_SIZE] ) 699 { 700 return detail::UpdateGameModeDescription( description ); 701 } 702 703 704 /* Please see man pages for details 705 706 707 708 709 710 711 712 713 714 715 716 717 718 */ 719 Result AttachToEventNotification( nn::os::Event* pEvent ); AttachToEventNotification(nn::os::Event * pEvent)720 inline Result AttachToEventNotification( nn::os::Event* pEvent ) 721 { 722 return detail::AttachToEventNotification( pEvent ); 723 } 724 725 /* Please see man pages for details 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 */ 741 Result SetNotificationMask( bit32 mask ); SetNotificationMask(bit32 mask)742 inline Result SetNotificationMask( bit32 mask ) 743 { 744 return detail::SetNotificationMask( mask ); 745 } 746 747 /* Please see man pages for details 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 */ 763 u32 GetEventNotification( 764 EventNotification* pEventNotificationList, 765 size_t size = 1, 766 bool* pHasOverflowed = NULL 767 ); GetEventNotification(EventNotification * pEventNotificationList,size_t size,bool * pHasOverflowed)768 inline u32 GetEventNotification( 769 EventNotification* pEventNotificationList, 770 size_t size, 771 bool* pHasOverflowed 772 ) 773 { 774 return detail::GetEventNotification( pEventNotificationList, size, pHasOverflowed ); 775 } 776 777 /* Please see man pages for details 778 779 780 781 782 783 784 785 786 787 788 789 */ 790 Result GetLastResponseResult(); GetLastResponseResult()791 inline Result GetLastResponseResult() 792 { 793 return detail::GetLastResponseResult(); 794 } 795 796 /* Please see man pages for details 797 798 799 800 801 802 803 804 805 806 807 */ 808 u32 ResultToErrorCode( const Result& result ); ResultToErrorCode(const Result & result)809 inline u32 ResultToErrorCode( const Result& result ) 810 { 811 return detail::ResultToErrorCode( result ); 812 } 813 814 } // end of namespace CTR 815 } // end of namespace friends 816 } // end of namespace nn 817 818 #endif // __cplusplus 819 820 // C declarations follow 821 822 #include <nn/util/detail/util_CLibImpl.h> 823 824 /* Please see man pages for details 825 826 827 828 */ 829 830 831 832 /* 833 834 */ 835 836 #endif // ifndef NN_FRIENDS_CTR_FRIENDS_API_H_ 837