Function openHubNoteboxForDevice

lib/hubreq.go:439–476

Open the endpoint's notebox

(ctx context.Context, session *HubSession, deviceUID string, deviceSN string, productUID string, endpointID string, event EventFunc)

// Open the endpoint's notebox
func openHubNoteboxForDevice(ctx context.Context, session *HubSession, deviceUID string, deviceSN string, productUID string, endpointID string, event EventFunc) (box *Notebox, ei *NotefileEventInfo, appUID string, err error) {
	timerName := timerBegin(ctx, "openNoteboxForDevice")
	defer timerEnd(ctx, timerName)

	// Warn if this take too long; it should be a few milliseconds
	start := time.Now()
	defer func() {
		if time.Since(start) > time.Second {
			session.LogWarn(ctx, "[timewarn] excessively long time to open the notebox: %s", time.Since(start))
		}
	}()

	// Ensure that hub endpoint is available
	var hubEndpointID, deviceStorageObject string
	timerName = timerBegin(ctx, "hubDiscover")
	hubEndpointID, appUID, deviceStorageObject, err = HubDiscover(deviceUID, deviceSN, productUID, appUID)
	timerEnd(ctx, timerName)
	if err != nil {
		return
	}

	// Open the endpoint's box on behalf of the Notehub, because we can't open it directly under the device endpoint IDs
	timerName = timerBegin(ctx, "openNotebox`")
	box, err = OpenEndpointNotebox(ctx, hubEndpointID, deviceStorageObject, true)
	timerEnd(ctx, timerName)
	if err != nil {
		return
	}

	// Set the default notification context for files opened within this box instance
	ei = EventInfo(deviceUID, deviceSN, productUID, appUID, session.Session.Transport, event, session)

	// If we haven't yet enum'ed the notefiles, do so
	sawNotefile(session, box, "")

	// Done
	return
}

// Ensure that the specified notefile is in the list
func sawNotefile(session *HubSession, box *Notebox, notefileID string) {