TweetFollow Us on Twitter

Cyberdog Intro
Volume Number:12
Issue Number:2
Column Tag:OpenDoc

Cyberdog, the OpenDoc

Internet Components

The future of Internet surfing is OpenDoc

by Stephen Humphrey, VP Engineering, Acorde Corporation

Cyberdog is the code name for Apple Computer’s OpenDoc-based Internet components. This article provides a 10,000-foot view of the Cyberdog architecture and a cursory introduction to the most important parts of its API.

Cyberdog will include components which provide Web browsing, SMTP and POP mail, Usenet News, FTP, Gopher, and Telnet. These components provide the sort of functionality one expects from Internet apps today, plus strong mutual integration with one another, and with a universal log, which keeps a historical record of the user’s actions, and a notebook, which stores pointers to the user’s favorite places and people. For instance, Cyberdog’s integrated SMTP and POP mail system (see Figure 1) is fully MIME-capable; addresses may be stored in the notebook for easy access; and any CyberItem may be sent as an enclosure. The News reader shows the familiar display of newsgroups and messages (see Figure 2), and any icon can be dragged to the notebook. Cyberdog is designed to improve the Internet experience for MacOS users by closely integrating the various

Figure 1. A Mail window

Figure 2. The News reader

components with each other, with other applications, and with the desktop. Apple will encourage third-party developers to extend and replace the base Cyberdog components by fully documenting the Cyberdog API and architecture.

As I write this article, Apple plans to distribute a sneak preview of the shared libraries which make up Cyberdog on the OpenDoc Developer Release 4 CD [in this issue]; the end-user release of the Cyberdog components is currently scheduled for May 1996.

The Cyberdog components factor their Internet responsi-bilities into three major areas: Viewers, Services, and Context facilities. Viewers are responsible for displaying the myriad data types commonly found on the Net, like JPEG and HTML. Services manage the protocols used for transporting the data types. Context facilities hold the history of the user’s interaction and help the users keep track of their favorite sites, newsgroups, and mail addresses.

Viewers are OpenDoc Part Editors

One of the most exciting aspects of Cyberdog is its extensive use of OpenDoc. Cyberdog depends fully on the OpenDoc architecture for displaying and interacting with Net-borne data. In fact, every part of Cyberdog that has a user interface(UI) is implemented as an OpenDoc part. Even those components which do not have a UI are implemented as SOM objects, so again they behave similarly to OpenDoc components. This dependence on OpenDoc means that a Cyber-aware Viewer you write will automatically benefit from the strengths of the OpenDoc architecture. So, for example, if you write a Cyberdog-savvy Stock Ticker, your users will be able to display dynamically-updating information about their portfolios in any OpenDoc container.

Cyberdog viewers are first and foremost OpenDoc viewers. To show a data type in Cyberdog, you first implement an editor based on ODPart. All of a regular OpenDoc part’s methods are required, and the part editor uses the standard OpenDoc event, layout, and storage facilities. To add the functionality of Cyberdog, you add an extension to your editor which inherits from CyberPartExtension.

CyberPartExtension is a virtual class which provides the methods with which the other Cyberdog components will interact with your viewer. You will write an extension which inherits the base functionality of CyberPartExtension but which also knows about the particular details of interacting with your editor. So for example, if you have already written a JPEG display part using OpenDoc, you will write a CyberJPEGExtension which provides your part with the additional capabilities of retrieving the JPEG data from the Net instead of just from your OpenDoc StorageUnit. CyberPartExtension is a standard ODExtension, so you will provide your extension to Cyberdog via the standard ODPart::HasExtension() and ODPart::GetExtension() mechanisms. After your part is initialized but before you create your first display frame, Cyberdog will tell your editor to use a CyberService to retrieve its data.

CyberServices Encapsulate Internet Protocols

A CyberService is the base class which manages a single Internet protocol. The basic Cyberdog components include CyberService implementations for HTTP, FTP, Gopher, Telnet, and the local file system. Notice that CyberServices represent transport protocols and not data types, so there is an FTPService, not a JPEGService. A CyberService’s most important role is as a manager of a few other classes of objects which actually implement a full Internet protocol, particularly the CyberItem and the CyberStream.

A CyberItem represents the address of a piece of data on the Net. In its simplest form, it can be thought of as an objected-oriented wrapper for a URL. In practice, there is nothing to stop much more advanced capabilities in a CyberItem, such as complete database queries. CyberItems are portable; they can be saved in your StorageUnit and reinstantiated later. If you are implementing a viewer which can contain one or more links to outside data, such as an HTML viewer, you will save CyberItems in your StorageUnit as part of your own content model, retrieving them when necessary based on action from the user. CyberItems have no inherent UI, so they inherit from SOMObject instead of ODPart.

A simple example of a CyberItem’s behavior is shown by a CyberButton, a simple Cyber-savvy viewer which comes with Cyberdog. A CyberButton is an OpenDoc part which behaves as a button (surprise!); it can be displayed in any OpenDoc container, can display a title or a picture on its face, and can be clicked on by the user. Internally, a CyberButton holds one CyberItem. When the user clicks on the CyberButton, the button calls the CyberItem’s Open() method. This is a fire-and-forget call; the CyberButton is not responsible for any additional interaction with the CyberItem. The CyberItem is free to take any appropriate action, the most common of which is to open a viewer to display the data pointed to by the CyberItem.

As a Cyber-savvy viewer, you become interested when the SetCyberItem() method of your CyberPartExtension is called. This tells you that you are being opened because the user fired a CyberItem, and you are provided a reference to that CyberItem. Your most common action then will be to ask the CyberItem to create a CyberStream through which you will get the data to display; to do this, call the CyberItem’s CreateCyberStream() method, and it will return a CyberStream.

CyberStreams Provide Clean Data to Viewers

A CyberStream implements the actual passing of data from a protocol to a viewer. After receiving a CyberStream from a CyberItem, you will tell the CyberStream to either Open() or OpenWithCallback(). This call tells the CyberStream that it should immediately begin downloading the data. It is the CyberStream’s responsibility to begin retrieving the data asynchronously and to store it until you ask for it.

If you opened the CyberStream by calling Open(), you will poll it for data by calling its GetStreamStatus() method. The most interesting replies are kDataAvailable and kDownloadComplete. If you opened the CyberStream by calling its OpenWithCallback() method, then the CyberStream will notify you whenever data is available by calling the notification method you register.

Any time the CyberStream has data available, you can request a chunk of data from the stream with the call GetBuffer(). When you are finished processing the data, you must call ReleaseBuffer(). If you are using a callback method to notify you when data is available, you must remember that this notification may happen at interrupt time; you will not be able to allocate memory, draw to the screen, or perform any other action which is not interrupt-safe. However, it is okay to set an internal state which will get and process the data later, such as at idle time. The CyberStream may only have a limited number of buffers, so it is a good idea to release them as soon as you are able to. You will continue calling GetBuffer() and ReleaseBuffer() until the CyberStream reports it is finished downloading.

CyberStreams are responsible for parsing the data stream and removing any protocol-specific headers or similar data blocks in the stream. This has the advantage of providing the viewer with a consistent stream of data regardless of the data’s transfer protocol on the Net. So for example, your JPEGViewer need not care whether the CyberItem it receives is really a GopherItem, an FTPItem, or a FileItem; regardless of the protocol the user chose, the JPEG stream you receive will be the same.

One limitation of the method described above is that sometimes a CyberItem doesn’t know what kind of viewer it should open. For example, a WebItem cannot open an appropriate viewer until it knows the kind of data at which it is pointing, that is, until it parses the HTML and finds an appropriate data-type tag. In this case, the CyberItem will actually open the CyberStream and start it downloading even before the real viewer is opened. The CyberItem will also open a special OpenerPart that will display the download status until the real viewer can be determined and opened. However, as a viewer you will not know or care that the stream has already been opened; you will ask the CyberItem to create a CyberStream, ask the CyberStream to open, and begin polling as usual.

As of now, CyberStreams are designed primarily to pass data in one direction. This is decidedly unhelpful for some protocols which depend on more interactive communication between the viewer and the stream. For example, the telnet protocol cannot be implemented efficiently using CyberStreams. Thus, when a TelnetItem (a telnet CyberItem) asks a TelnetViewer to open, the TelnetViewer never requests a TelnetStream. Instead, it just fully implements the telnet protocol within the viewer by asking the TelnetItem for its connection information and creating the connection itself. Since no CyberConnection object exists, this means implementing these types of protocols is fairly tedious today. This is a great opportunity for either a future version of Cyberdog or for a smart third-party.

Context Facilities Tie the Parts Together

Cyberdog provides several built-in context facilities which unite the various components into a seamless Internet workspace. These include a common Connect dialog, a Preferences panel, the Log, and Notebooks. Each of these is managed through the single CyberSession object.

The CyberSession is responsible for the overall integration of the Cyberdog components. It is similar in purpose to the OpenDoc session object, ODSession, although it is different in the particular services it provides. There is at most one CyberSession for each ODSession. The CyberSession is the main facility through which Viewers will request various Cyberdog objects. It is also the facility through which standard OpenDoc containers will be able to add the Cyberdog menus to their menu bar. Among its responsibilities, the CyberSession checks the Cyberdog libraries folder to see which CyberServices are available. This is what allows the run-time addition of new services to Cyberdog’s repertoire.

CyberServices may provide a Connect panel. If provided, this part allows the Cyberdog Connect dialog to display protocol-specific fields for any service available to the user. In operation, the Connect dialog is reminiscent of the pre-System 7 Control Panel dialog, with scrolling icons on the left and individual panels on the right. Since the panels are implemented as regular OpenDoc parts, a service which implements a new protocol can easily provide a panel for the CyberSession to display to the user. Such a Connect panel is implemented by adding a CyberPanelExtension to a regular part subclassed from ODPart.

Similarly, any CyberService can provide a Preferences panel that the CyberSession will display in the Cyberdog Preferences Dialog. A Preferences panel, too, is implemented by adding a CyberPanelExtension to a regular part subclassed from ODPart. (This implementation of the Cyberdog dialog boxes provides one of the best non-document uses of OpenDoc to date; it validates OpenDoc as more than just a compound-document architecture.)

To provide an historical context for the user’s actions, Cyberdog provides a universal Log which tracks where the user has been on the Net. The user can show the log, display its items hierarchically, alphabetically, or historically, and return to places in it by simply clicking on the place’s icon (see Figure 3). A Viewer posts a new item on the log by providing a CyberItem (and optionally, its hierarchical parent) to the CyberSession’s AddCyberItemToLog() method.

Figure 3. The Log window

The user may also save one or more Cyberdog Notebooks (see Figure 4). These simple lists of CyberItems have a single-level folder system in which the user can organize favorite places and people. The user identifies a default notebook, and Viewers may add an item to this default notebook by simply telling the CyberSession to AddCyberItemToNotebook(). More typically, Viewers allow the user to drag CyberItems to a Notebook using the OpenDoc drag-and-drop facilities (so the user can drag e-mail addresses, newsgroups, Web sites, Gopher directories, and telnet connections right into a Notebook). Like other parts of Cyberdog, the Notebook is designed to implement the minimum functionality required by a beginning Internet user; it is ripe for replacement by an enterprising third-party.

Figure 4. The Notebook

Where To Go From Here

By the time you read this article, the Cyberdog components and SDK should be available on the OpenDoc DR4 CD. The SDK is quite preliminary, but should be sufficient to get started with developing for Cyberdog (especially if you’re not afraid to bleed a little). Various listservers have been established to facilitate Cyberdog discussion. Mail a message to cdog@apple.com with subject “DEV-INFO” for more information.

Apple has done a commendable job of designing Cyberdog. From its foundation, Cyberdog’s architecture permits and even encourages third-party developers to replace and extend it. Since it is still alpha-quality code, expect some pain. However, developers who learn to walk the ’dog now might discover opportunities and markets that will be harder to find later. If you start early, the ’dog will probably bite you occasionally; but once you’ve learned to handle it, you’ll be able to cuddle up close.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

VMware Fusion 11.5.6 - Run Windows apps...
VMware Fusion and Fusion Pro - virtualization software for running Windows, Linux, and other systems on a Mac without rebooting. The latest version includes full support for Windows 10, macOS Mojave... Read more
Alfred 4.1 - Quick launcher for apps and...
Alfred is an award-winning productivity application for OS X. Alfred saves you time when you search for files online or on your Mac. Be more productive with hotkeys, keywords, and file actions at... Read more
Dashlane 6.2032.0 - Password manager and...
Dashlane is an award-winning service that revolutionizes the online experience by replacing the drudgery of everyday transactional processes with convenient, automated simplicity - in other words,... Read more
Skype 8.63.0.76 - Voice-over-internet ph...
Skype is a telecommunications app that provides HD video calls, instant messaging, calling to any phone number or landline, and Skype for Business for productive cooperation on the projects. This... Read more
Mellel 5.0.3 - The word processor for sc...
Mellel is the leading word processor for OS X and has been widely considered the industry standard for long form documents since its inception. Mellel focuses on writers and scholars for technical... Read more
A Better Finder Rename 11.20 - File, pho...
A Better Finder Rename is the most complete renaming solution available on the market today. That's why, since 1996, tens of thousands of hobbyists, professionals and businesses depend on A Better... Read more
TunnelBear 3.9.10 - Subscription-based p...
TunnelBear is a subscription-based virtual private network (VPN) service and companion app, enabling you to browse the internet privately and securely. Features Browse privately - Secure your data... Read more
Dropbox 103.4.383 - Cloud backup and syn...
Dropbox for Mac is a file hosting service that provides cloud storage, file synchronization, personal cloud, and client software. It is a modern workspace that allows you to get to all of your files... Read more
Daylite 2020.29.1 - Dynamic business org...
Daylite helps businesses organize themselves with tools such as shared calendars, contacts, tasks, projects, notes, and more. Enable easy collaboration with features such as task and project... Read more
HoudahSpot 5.1.5 - Advanced file-search...
HoudahSpot is a versatile desktop search tool. Use HoudahSpot to locate hard-to-find files and keep frequently used files within reach. HoudahSpot will immediately feel familiar. It works just the... Read more

Latest Forum Discussions

See All

Motorball is a car football game from No...
A few years back Noodlecake Studios announced that they would be dipping in the multiplayer gaming realm with two different games. The first of those, Golf Blitz, released a while back and has proven to be very popular. Now, the second has arrived... | Read more »
SINoALICE's latest update introduce...
SINoALICE's latest update has now arrived, adding several fan-favourite characters from popular RPG series NieR. Young Nier, Kaine, and Young Emil are available in-game as part of a limited-time crossover event set to run until August 20th. [Read... | Read more »
Rocat Jumpurr is an intense roguelite pl...
Rocat Jumpurr is a roguelite platformer from developer Mousetrap Games. You might already be familiar with it if you follow the Big Indie Pitch, where it won first place during this year's Pocket Gamer Connects London competition. Following its... | Read more »
PUBG Mobile's Play As One campaign...
Back in mid-July, we reported that PUGB Mobile had teamed up with Direct Relief to help raise money for the charity's COVID-19 response project. It focused on an in-game running challenge for players, which lead to the PUBG Mobile donating $2... | Read more »
Marvel Contest of Champions' latest...
Marvel Contest of Champions' latest motion comic has arrived, and it shows off new fighters Air-Walker and Dragon Man. Both characters are set to arrive in-game this month. [Read more] | Read more »
Clash Royale: The Road to Legendary Aren...
Supercell recently celebrated its 10th anniversary and their best title, Clash Royale, is as good as it's ever been. Even for lapsed players, returning to the game is as easy as can be. If you want to join us in picking the game back up, we've put... | Read more »
Global Spy is an intriguing 2D spy sim f...
Developer Yuyosoft Innovations' Global Spy launched last month for iOS and Android, though if you missed it at the time, we're here to tell you why it's well worth a go. This one's all about international espionage, tracking down elusive spies,... | Read more »
Distract Yourself With These Great Mobil...
There’s a lot going on right now, and I don’t really feel like trying to write some kind of pithy intro for it. All I’ll say is lots of people have been coming together and helping each other in small ways, and I’m choosing to focus on that as I... | Read more »
Hyena Squad is sci-fi turn-based strateg...
Wave Light Games has just revealed its latest release, Hyena Squad, a turn-based RPG set in a space station infested by gross aliens and the living dead. The announcement was first reported on by Touch Arcade. [Read more] | Read more »
Idle Guardians: Never Die is a pixel art...
SuperPlanet has been fairly prolific with game releases so far this year with both Evil Hunter Tycoon and Lucid Adventure releasing earlier this year. Now, they've released another idle RPG called Idle Guardians: Never Die, which you can download... | Read more »

Price Scanner via MacPrices.net

Apple restocks refurbished 2020 13″ MacBook A...
Apple has restocked Certified Refurbished 2020 13″ MacBook Airs starting at only $849 and up to $200 off the cost of new Airs. Each MacBook features a new outer case, comes with a standard Apple one-... Read more
Apple restocks clearance 2019 13″ 2.4GHz MacB...
Apple has restocked Certified Refurbished 2019 13″ 2.4GHz 4-Core Touch Bar MacBook Pros starting at $1359 and up to $560 off original MSRP. Apple’s one-year warranty is included, shipping is free,... Read more
Apple restocks refurbished iPhone XR models s...
Apple has restocked Certified Refurbished, unlocked, iPhone XR models in the refurbished section of their online store starting at $539. Each iPhone comes with Apple’s standard one-year warranty,... Read more
Price drops! $100-$200 off clearance 27″ 5K i...
B&H Photo has dropped prices on clearance, previous-generation 27″ 5K iMacs by up to $200 off Apple’s original MSRP: – 27″ 3.0GHz 6-Core 5K iMac: $1699 $100 off original MSRP – 27″ 3.1GHz 6-Core... Read more
Woot offers Apple Watch and iPhone models fro...
Amazon-owned Woot has refurbished Apple Watch and iPhone models available from $99-$749 through August 6th. According to Woot, the items may show some wear, but they have all been fully tested and... Read more
Apple’s Phil Schiller Steps Down As SVP OF Wo...
NEWS: 08.05.20 – Former Apple senior Vice President of worldwide marketing, Phil Schiller, is stepping down from his long time role at the company in order to focus on spending more time with family... Read more
Expercom offers $320 discount on the 6-core 1...
Apple reseller Expercom has the Silver 16″ 6-core MacBook Pro on sale for a limited time for $2079 shipped. Their price is $320 off Apple’s MSRP for this model, and it’s the cheapest price currently... Read more
Apple announces Education pricing for new 202...
Purchase a new 2020 iMac or iMac Pro at Apple using Apple’s Education discount, and take up to $400 off MSRP. All teachers, students, and staff of any educational institution with a .edu email... Read more
Apple reseller Expercom offers $256 discount...
Expercom has Apple’s new 2020 10-core iMac Pro available for order and on sale for $4743 shipped. Their price is $256 off Apple’s MSRP for this new model, and it’s the cheapest price we’ve seen so... Read more
Apple releases refreshed 2020 27″ iMacs with...
Apple today released updated versions of their 27″ iMacs featuring 10th generation Intel processors, SSDs across the board, a better 5K display, and improvements to the camera, speakers, and mic.... Read more

Jobs Board

Executive Team Leader GM Sales (Assistant Man...
…(Assistant Manager General Merchandise and Operations) - Apple Valley, CaliforniaApply NowJob ID:R0000082364job family:Store Managementschedule:Full Read more
Cub Foods - *Apple* Valley - Now Hiring Par...
Cub Foods - Apple Valley - Now Hiring Part Time! United States of America, Minnesota, Apple Valley New Retail Post Date 2 days ago Requisition # 122305 Sign Up Read more
Part-time Geek Squad *Apple* Consultation P...
**770829BR** **Job Title:** Part-time Geek Squad Apple Consultation Professional-Store 384(Ithaca) **Job Category:** Store Associates **Store Number or Department:** Read more
Product Manager, *Apple* Commercial Sales -...
Product Manager, Apple Commercial Sales Austin, TX, US Requisition Number:77652 As an Apple Product Manager for the Commercial Sales team at Insight, you Read more
Cub Foods - *Apple* Valley - Now Hiring Par...
Cub Foods - Apple Valley - Now Hiring Part Time! United States of America, Minnesota, Apple Valley New Retail Post Date 1 day ago Requisition # 122305 Sign Up Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.