sap

Documentation

Overview

BlueZ D-Bus Sim Access API description [sap-api.txt]

Index

• Variables
• type SimAccess1
  • func NewSimAccess1(objectPath dbus.ObjectPath) (*SimAccess1, error)
  • func (a *SimAccess1) Client() *bluez.Client
  • func (a *SimAccess1) Close()
  • func (a *SimAccess1) Disconnect() error
  • func (a *SimAccess1) GetConnected() (bool, error)
  • func (a *SimAccess1) GetObjectManagerSignal() (chan *dbus.Signal, func(), error)
  • func (a *SimAccess1) GetProperties() (*SimAccess1Properties, error)
  • func (a *SimAccess1) GetPropertiesSignal() (chan *dbus.Signal, error)
  • func (a *SimAccess1) GetProperty(name string) (dbus.Variant, error)
  • func (a *SimAccess1) GetWatchPropertiesChannel() chan *dbus.Signal
  • func (a *SimAccess1) Interface() string
  • func (a *SimAccess1) Path() dbus.ObjectPath
  • func (a *SimAccess1) SetConnected(v bool) error
  • func (a *SimAccess1) SetProperty(name string, value interface{}) error
  • func (a *SimAccess1) SetWatchPropertiesChannel(c chan *dbus.Signal)
  • func (a *SimAccess1) ToProps() bluez.Properties
  • func (a *SimAccess1) UnwatchProperties(ch chan *bluez.PropertyChanged) error
  • func (a *SimAccess1) WatchProperties() (chan *bluez.PropertyChanged, error)
• type SimAccess1Properties
  • func (a *SimAccess1Properties) FromDBusMap(props map[string]dbus.Variant) (*SimAccess1Properties, error)
  • func (a *SimAccess1Properties) FromMap(props map[string]interface{}) (*SimAccess1Properties, error)
  • func (p *SimAccess1Properties) Lock()
  • func (a *SimAccess1Properties) ToMap() (map[string]interface{}, error)
  • func (p *SimAccess1Properties) Unlock()

Variables

var SimAccess1Interface = "org.bluez.SimAccess1"

Types

type SimAccess1

type SimAccess1 struct {
	Properties *SimAccess1Properties
	// contains filtered or unexported fields
}

SimAccess1 Sim Access Profile hierarchy

func NewSimAccess1

func NewSimAccess1(objectPath dbus.ObjectPath) (*SimAccess1, error)

NewSimAccess1 create a new instance of SimAccess1

Args: - objectPath: [variable prefix]/{hci0,hci1,...}

func (*SimAccess1) Client

func (a *SimAccess1) Client() *bluez.Client

Client return SimAccess1 dbus client

func (*SimAccess1) Close

func (a *SimAccess1) Close()

Close the connection

func (*SimAccess1) Disconnect

func (a *SimAccess1) Disconnect() error

Disconnect Disconnects SAP client from the server.

Possible errors: org.bluez.Error.Failed

func (*SimAccess1) GetConnected

func (a *SimAccess1) GetConnected() (bool, error)

GetConnected get Connected value

func (*SimAccess1) GetObjectManagerSignal

func (a *SimAccess1) GetObjectManagerSignal() (chan *dbus.Signal, func(), error)

GetObjectManagerSignal return a channel for receiving updates from the ObjectManager

func (*SimAccess1) GetProperties

func (a *SimAccess1) GetProperties() (*SimAccess1Properties, error)

GetProperties load all available properties

func (*SimAccess1) GetPropertiesSignal

func (a *SimAccess1) GetPropertiesSignal() (chan *dbus.Signal, error)

GetPropertiesSignal return a channel for receiving udpdates on property changes

func (*SimAccess1) GetProperty

func (a *SimAccess1) GetProperty(name string) (dbus.Variant, error)

GetProperty get a property

func (*SimAccess1) GetWatchPropertiesChannel

func (a *SimAccess1) GetWatchPropertiesChannel() chan *dbus.Signal

GetWatchPropertiesChannel return the dbus channel to receive properties interface

func (*SimAccess1) Interface

func (a *SimAccess1) Interface() string

Interface return SimAccess1 interface

func (*SimAccess1) Path

func (a *SimAccess1) Path() dbus.ObjectPath

Path return SimAccess1 object path

func (*SimAccess1) SetConnected

func (a *SimAccess1) SetConnected(v bool) error

SetConnected set Connected value

func (*SimAccess1) SetProperty

func (a *SimAccess1) SetProperty(name string, value interface{}) error

SetProperty set a property

func (*SimAccess1) SetWatchPropertiesChannel

func (a *SimAccess1) SetWatchPropertiesChannel(c chan *dbus.Signal)

SetWatchPropertiesChannel set the dbus channel to receive properties interface

func (*SimAccess1) ToProps

func (a *SimAccess1) ToProps() bluez.Properties

ToProps return the properties interface

func (*SimAccess1) UnwatchProperties

func (a *SimAccess1) UnwatchProperties(ch chan *bluez.PropertyChanged) error

func (*SimAccess1) WatchProperties

func (a *SimAccess1) WatchProperties() (chan *bluez.PropertyChanged, error)

WatchProperties updates on property changes

type SimAccess1Properties

type SimAccess1Properties struct {

	/*
		Connected Indicates if SAP client is connected to the server.
	*/
	Connected bool
	// contains filtered or unexported fields
}

SimAccess1Properties contains the exposed properties of an interface

func (*SimAccess1Properties) FromDBusMap

func (a *SimAccess1Properties) FromDBusMap(props map[string]dbus.Variant) (*SimAccess1Properties, error)

FromDBusMap convert a map to an SimAccess1Properties

func (*SimAccess1Properties) FromMap

func (a *SimAccess1Properties) FromMap(props map[string]interface{}) (*SimAccess1Properties, error)

FromMap convert a map to an SimAccess1Properties

func (*SimAccess1Properties) Lock

func (p *SimAccess1Properties) Lock()

Lock access to properties

func (*SimAccess1Properties) ToMap

func (a *SimAccess1Properties) ToMap() (map[string]interface{}, error)

ToMap convert a SimAccess1Properties to map

func (*SimAccess1Properties) Unlock

func (p *SimAccess1Properties) Unlock()

Unlock access to properties