Struct GKMatchmaker

#[repr(C)]
pub struct GKMatchmaker { /* private fields */ }

Available on crate feature GKMatchmaker only.

GKMatchmaker is a singleton object to manage match creation from invites and automatching.

See also Apple’s documentation

Implementations

impl GKMatchmaker

pub unsafe fn sharedMatchmaker() -> Retained<GKMatchmaker>

The shared matchmaker

pub unsafe fn matchForInvite_completionHandler( &self, invite: &GKInvite, completion_handler: Option<&DynBlock<dyn Fn(*mut GKMatch, *mut NSError)>>, )

Available on crate features GKMatch and block2 only.

Get a match for an accepted invite Possible reasons for error:

1. Communications failure
2. Invite cancelled

pub unsafe fn findMatchForRequest_withCompletionHandler( &self, request: &GKMatchRequest, completion_handler: Option<&DynBlock<dyn Fn(*mut GKMatch, *mut NSError)>>, )

Available on crate features GKMatch and block2 only.

Automatching or invites to find a peer-to-peer match for the specified request. Error will be nil on success: Possible reasons for error:

1. Communications failure
2. Unauthenticated player
3. Timeout Note that the players property on the returned GKMatch instance will only contain connected players. It will initially be empty as players are connecting. Implement the GKMatchDelegate method match:player:didChangeConnectionState: to listen for updates to the GKMatch instance’s players property.

pub unsafe fn findPlayersForHostedRequest_withCompletionHandler( &self, request: &GKMatchRequest, completion_handler: Option<&DynBlock<dyn Fn(*mut NSArray<GKPlayer>, *mut NSError)>>, )

Available on crate features GKBasePlayer and GKPlayer and block2 only.

Automatching or invites for host-client match request. This returns a list of player identifiers to be included in the match. Determination and communication with the host is not part of this API. When inviting, no player identifiers will be returned. Player responses will be reported via the inviteeResponseHandler. Possible reasons for error:

1. Communications failure
2. Unauthenticated player
3. Timeout

pub unsafe fn findMatchedPlayers_withCompletionHandler( &self, request: &GKMatchRequest, completion_handler: &DynBlock<dyn Fn(*mut GKMatchedPlayers, *mut NSError)>, )

Available on crate feature block2 only.

Automatching or invites for host-client rule-based match request.

pub unsafe fn addPlayersToMatch_matchRequest_completionHandler( &self, match: &GKMatch, match_request: &GKMatchRequest, completion_handler: Option<&DynBlock<dyn Fn(*mut NSError)>>, )

Available on crate features GKMatch and block2 only.

Automatching or invites to add additional players to a peer-to-peer match for the specified request. Error will be nil on success: Possible reasons for error:

1. Communications failure
2. Timeout

pub unsafe fn cancel(&self)

Cancel matchmaking and any pending invites

pub unsafe fn cancelPendingInviteToPlayer(&self, player: &GKPlayer)

Available on crate features GKBasePlayer and GKPlayer only.

Cancel a pending invitation to a player

pub unsafe fn finishMatchmakingForMatch(&self, match: &GKMatch)

Available on crate feature GKMatch only.

Call this when finished with all programmatic P2P invites/matchmaking, for compatability with connected players using GKMatchmakerViewController.

pub unsafe fn queryPlayerGroupActivity_withCompletionHandler( &self, player_group: NSUInteger, completion_handler: Option<&DynBlock<dyn Fn(NSInteger, *mut NSError)>>, )

Available on crate feature block2 only.

Query the server for recent activity in the specified player group. A larger value indicates that a given group has seen more recent activity. Error will be nil on success. Possible reasons for error:

1. Communications failure

pub unsafe fn queryActivityWithCompletionHandler( &self, completion_handler: Option<&DynBlock<dyn Fn(NSInteger, *mut NSError)>>, )

Available on crate feature block2 only.

Query the server for recent activity for all the player groups of that game. Error will be nil on success. Possible reasons for error:

1. Communications failure

pub unsafe fn queryQueueActivity_withCompletionHandler( &self, queue_name: &NSString, completion_handler: Option<&DynBlock<dyn Fn(NSInteger, *mut NSError)>>, )

Available on crate feature block2 only.

Query the server for recent activity for the specified queue.

pub unsafe fn startBrowsingForNearbyPlayersWithHandler( &self, reachable_handler: Option<&DynBlock<dyn Fn(NonNull<GKPlayer>, Bool)>>, )

Available on crate features GKBasePlayer and GKPlayer and block2 only.

Start browsing for nearby players that can be invited to a match. The reachableHandler will be called for each player found with a compatible game. It may be called more than once for the same player if that player ever becomes unreachable (e.g. moves out of range). You should call stopBrowsingForNearbyPlayers when finished browsing.

pub unsafe fn stopBrowsingForNearbyPlayers(&self)

Stop browsing for nearby players.

pub unsafe fn startGroupActivityWithPlayerHandler( &self, handler: &DynBlock<dyn Fn(NonNull<GKPlayer>)>, )

Available on crate features GKBasePlayer and GKPlayer and block2 only.

Activate a group activity by Game Center for your game, which allows people in the FaceTime call to join the local player’s game. The handler will be called for each player who joined from the activity.

pub unsafe fn stopGroupActivity(&self)

End the group activity created by Game Center for your game, which was activated by the local player.

impl GKMatchmaker

Methods declared on superclass NSObject.

pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>

pub unsafe fn new() -> Retained<Self>

impl GKMatchmaker

GKDeprecated.

pub unsafe fn inviteHandler( &self, ) -> *mut DynBlock<dyn Fn(NonNull<GKInvite>, *mut NSArray)>

👎Deprecated: Use the GKLocalPlayer/register(_:) method instead.

Available on crate feature block2 only.

pub unsafe fn setInviteHandler( &self, invite_handler: Option<&DynBlock<dyn Fn(NonNull<GKInvite>, *mut NSArray)>>, )

👎Deprecated: Use the GKLocalPlayer/register(_:) method instead.

Available on crate feature block2 only.

Setter for inviteHandler.

impl GKMatchmaker

Obsoleted.

pub unsafe fn startBrowsingForNearbyPlayersWithReachableHandler( &self, reachable_handler: Option<&DynBlock<dyn Fn(NonNull<NSString>, Bool)>>, )

👎Deprecated

Available on crate feature block2 only.

• This method is obsolete. It will never be invoked and its implementation does nothing**

pub unsafe fn cancelInviteToPlayer(&self, player_id: &NSString)

👎Deprecated

• This method is obsolete. It will never be invoked and its implementation does nothing**

pub unsafe fn findPlayersForHostedMatchRequest_withCompletionHandler( &self, request: &GKMatchRequest, completion_handler: Option<&DynBlock<dyn Fn(*mut NSArray<NSString>, *mut NSError)>>, )

👎Deprecated

Available on crate feature block2 only.

• This method is obsolete. It will never be invoked and its implementation does nothing**

Methods from Deref<Target = NSObject>

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

pub fn class(&self) -> &'static AnyClass

Dynamically find the class of this object.

Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T

where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Use Ivar::load instead.

Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

pub fn downcast_ref<T>(&self) -> Option<&T>

where T: DowncastTarget,

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}

Trait Implementations

impl AsRef<AnyObject> for GKMatchmaker

fn as_ref(&self) -> &AnyObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<GKMatchmaker> for GKMatchmaker

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSObject> for GKMatchmaker

fn as_ref(&self) -> &NSObject

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<AnyObject> for GKMatchmaker

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for GKMatchmaker

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for GKMatchmaker

const NAME: &'static str = "GKMatchmaker"

The name of the Objective-C class that this type represents.

type Super = NSObject

The superclass of this class.

type ThreadKind = <<GKMatchmaker as ClassType>::Super as ClassType>::ThreadKind

Whether the type can be used from any thread, or from only the main thread.

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents.

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

impl Debug for GKMatchmaker

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for GKMatchmaker

type Target = NSObject

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Hash for GKMatchmaker

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for GKMatchmaker

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for GKMatchmaker

fn isEqual(&self, other: Option<&AnyObject>) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure.

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T>(&self) -> bool

where T: ClassType, Self: Sized + Message,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl PartialEq for GKMatchmaker

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefEncode for GKMatchmaker

const ENCODING_REF: Encoding = <NSObject as ::objc2::RefEncode>::ENCODING_REF

The Objective-C type-encoding for a reference of this type.

impl DowncastTarget for GKMatchmaker

impl Eq for GKMatchmaker