Struct GKSession 

pub struct GKSession { /* private fields */ }

👎Deprecated

Available on crate feature GKSession only.

The GKSession handles networking between peers for a game, which includes establishing and maintaining connections over a game network, and network data transport.

This a not a Game Center feature. To support Game Center and online play, see GKMatch.

See also Apple’s documentation

Implementations

impl GKSession

pub unsafe fn initWithSessionID_displayName_sessionMode( this: Allocated<Self>, session_id: Option<&NSString>, name: Option<&NSString>, mode: GKSessionMode, ) -> Option<Retained<Self>>

👎Deprecated: No longer available

Available on crate feature GKPublicConstants only.

Safety

• session_id might not allow None.
• name might not allow None.

pub unsafe fn delegate( &self, ) -> Option<Retained<ProtocolObject<dyn GKSessionDelegate>>>

👎Deprecated: No longer supported.

Available on crate feature GKPublicProtocols only.

pub unsafe fn setDelegate( &self, delegate: Option<&ProtocolObject<dyn GKSessionDelegate>>, )

👎Deprecated: No longer supported.

Available on crate feature GKPublicProtocols only.

Setter for delegate.

This is a weak property.

Safety

delegate might not allow None.

pub unsafe fn sessionID(&self) -> Option<Retained<NSString>>

👎Deprecated

pub unsafe fn displayName(&self) -> Option<Retained<NSString>>

👎Deprecated

pub unsafe fn sessionMode(&self) -> GKSessionMode

👎Deprecated: No longer supported.

Available on crate feature GKPublicConstants only.

pub unsafe fn peerID(&self) -> Option<Retained<NSString>>

👎Deprecated

pub unsafe fn isAvailable(&self) -> bool

👎Deprecated

Toggle availability on the network based on session mode and search criteria. Delegate will get a callback -session:didReceiveConnectionRequestFromPeer: when a peer attempts a connection.

pub unsafe fn setAvailable(&self, available: bool)

👎Deprecated

Setter for isAvailable.

pub unsafe fn disconnectTimeout(&self) -> NSTimeInterval

👎Deprecated

The timeout for disconnecting a peer if it appears that the peer has lost connection to the game network

pub unsafe fn setDisconnectTimeout(&self, disconnect_timeout: NSTimeInterval)

👎Deprecated

Setter for disconnectTimeout.

pub unsafe fn displayNameForPeer( &self, peer_id: Option<&NSString>, ) -> Option<Retained<NSString>>

👎Deprecated

Return the application chosen name of a specific peer

Safety

peer_id might not allow None.

pub unsafe fn sendData_toPeers_withDataMode_error( &self, data: Option<&NSData>, peers: Option<&NSArray>, mode: GKSendDataMode, error: Option<&mut Option<Retained<NSError>>>, ) -> bool

👎Deprecated: No longer supported.

Available on crate feature GKPublicConstants only.

Asynchronous delivery of data to one or more peers. Returns YES if delivery started, NO if unable to start sending, and error will be set. Delivery will be reliable or unreliable as set by mode.

Safety

• data might not allow None.
• peers generic should be of the correct type.
• peers might not allow None.
• error might not allow None.

pub unsafe fn sendDataToAllPeers_withDataMode_error( &self, data: Option<&NSData>, mode: GKSendDataMode, error: Option<&mut Option<Retained<NSError>>>, ) -> bool

👎Deprecated: No longer supported.

Available on crate feature GKPublicConstants only.

Asynchronous delivery to all peers. Returns YES if delivery started, NO if unable to start sending, and error will be set. Delivery will be reliable or unreliable as set by mode.

Safety

• data might not allow None.
• error might not allow None.

pub unsafe fn setDataReceiveHandler_withContext( &self, handler: Option<&AnyObject>, context: *mut c_void, )

👎Deprecated

Set the handler to receive data sent from remote peers.

Safety

• handler should be of the correct type.
• handler might not allow None.
• context must be a valid pointer.

pub unsafe fn connectToPeer_withTimeout( &self, peer_id: Option<&NSString>, timeout: NSTimeInterval, )

👎Deprecated

Attempt connection to a remote peer. Remote peer gets a callback to -session:didReceiveConnectionRequestFromPeer:.

Success results in a call to delegate -session:peer:didChangeState: GKPeerStateConnected Failure results in a call to delegate -session:connectionWithPeerFailed:withError:

Safety

peer_id might not allow None.

pub unsafe fn cancelConnectToPeer(&self, peer_id: Option<&NSString>)

👎Deprecated

Safety

peer_id might not allow None.

pub unsafe fn acceptConnectionFromPeer_error( &self, peer_id: Option<&NSString>, error: Option<&mut Option<Retained<NSError>>>, ) -> bool

👎Deprecated

Methods to accept or deny a prior connection request from -session:didReceiveConnectionRequestFromPeer:

Safety

• peer_id might not allow None.
• error might not allow None.

pub unsafe fn denyConnectionFromPeer(&self, peer_id: Option<&NSString>)

👎Deprecated

Safety

peer_id might not allow None.

pub unsafe fn disconnectPeerFromAllPeers(&self, peer_id: Option<&NSString>)

👎Deprecated

Disconnect a peer from the session (the peer gets disconnected from all connected peers).

Safety

peer_id might not allow None.

pub unsafe fn disconnectFromAllPeers(&self)

👎Deprecated

Disconnect local peer

pub unsafe fn peersWithConnectionState( &self, state: GKPeerConnectionState, ) -> Option<Retained<NSArray>>

👎Deprecated: No longer supported.

Available on crate feature GKPublicConstants only.

Returns peers according to connection state

impl GKSession

Methods declared on superclass NSObject.

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

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

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 GKSession

fn as_ref(&self) -> &AnyObject

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

impl AsRef<GKSession> for GKSession

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for GKSession

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for GKSession

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for GKSession

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for GKSession

const NAME: &'static str = "GKSession"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = <<GKSession 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 GKSession

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

Formats the value using the given formatter.

impl Deref for GKSession

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for GKSession

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 GKSession

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for GKSession

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 GKSession

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 GKSession

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

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

impl DowncastTarget for GKSession

impl Eq for GKSession